Skip to main content

How Our API Works

Our API is designed to either generate IDs for new entities or accept IDs provided by your system.

Since the create (POST) operations in our API do not return any content, it is advisable to supply the ID of the entity you wish to create. This allows you to easily reference the entity later.

Providing an ID is optional. However, if you choose not to supply one, you will need to perform additional steps to retrieve the newly created data, which may be more complex than simply supplying an ID upfront.

All requests should be authorized by a token in the header, except for the request that generates the token.