Skip to main content

API Reference

The API is organized around REST. It relies on resource-oriented URLs, JSON-encoded request bodies & responses, and uses standard HTTP response codes, authentication, and verbs.

The does not support (yet) write operations.


The API uses API keys to authenticate requests. You can view and manage your API keys in your workspace settings.

Your API keys represent a read-only access to your workspace resources, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be authenticated using an Authorization header & sent over HTTPS.

curl -L -X GET '' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'


Some resources have support for bulk fetches via "list" API methods. These list API methods rely on the same two parameters: limit & after in requests.

Responses contain has_more & total_count attributes to let you know if you're done fetching all items. You can use the id of the last item of the previous page to fetch the next one by using its value for after.