Booklet API

Booklet has a basic API that allows you to interact with your community using code. This is useful for automating tasks, like adding new members.

API endpoints

Booklet has a RESTful API with an OpenAPI spec. View the docs at:

API keys

To use the API, you need an API key. You can generate an API key in the Settings page of your community. Each API key has a name, which is useful for you to keep track of what each key is used for.

Only Admins on a community with a paid plan can generate API keys. If you’re not an Admin, ask an Admin to generate an API key for you.

API keys are secret, and should be treated like a password. Don’t share your API key with anybody. They give full access to your community, including the ability to add and remove members, and delete posts.

After an API key is generated, it can’t be viewed again. If you lose your API key, you can generate a new one.

The settings page shows all active API keys, and when they were last used. You can revoke API keys from this page.