📢 We're in Beta! We'd love your feedback Share your thoughts

Authentication & API Tokens

What it is

To interact with your personal data using the VerseDB API — like Collections, Wishlists, Pull Lists, or reading progress — you’ll need to authenticate with a Bearer token.

Tokens act as your access key and allow secure communication with the API on your behalf.

Where to get your token

To create and manage API tokens:

  1. Log into your VerseDB account
  2. Go to: https://versedb.com/user/api-tokens
  3. Give your token a name
  4. Choose the permissions you want (e.g., read:public, lists:collection, read:self)
  5. Click Create to generate your token

> You can create multiple tokens with different permissions for different tools or services.

Using the token

Once created, include your token in the Authorization header of your API requests like so: Authorization: Bearer your-api-token

Replace your-api-token with the actual token string you were given.

Important Notes

  • Keep your token private — don’t share or expose it
  • If it gets compromised, you can delete and regenerate a new one
  • Never commit tokens to public code (e.g., GitHub repos)

Token Permissions

When creating a token, you can select specific scopes to limit access:

  • read:public – Browse public content like series and characters
  • read:self – Read your own account data
  • lists:collection – Modify your collection
  • lists:wishlist – Modify your wishlist
  • lists:pulllist – Modify your pull list
  • lists:read – Manage read tracking
  • lists:follow – Follow/unfollow titles

Pick only what you need to improve security.


Tips & Troubleshooting

  • If you get a 401 Unauthorized response, check that your token is valid and the Authorization header is correct
  • You don’t need authentication for public data (e.g., GET /api/series/123)

Was this article helpful?

Please login to provide feedback