Public API Docs


The Brandkit API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

We have language bindings only in Shell for now! You can view code examples in the dark area to the right.


Brandkit API uses API Keys to allow access to the API. You can find it in Profile > More Tools > Api Key.

Brandkit API expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer API_KEY



List all assets

Returns a list of your assets.

Retrieve an asset

Retrieves the asset with the given ID.

Create asset

Creates an asset with the given parameters.



Retrieve a post

Retrieves the post with the given ID.

List all posts

Returns a list of your posts.

Create a post

Creates a post with the given parameters.



Test connection

Retrieves some basic information about the User's account such as account name and account url. It is meant to be used as a connection test.

Get all the available languages

Returns a list of all the available languages from an account.



Update user using email

Updates an existing user's data. Fields that can be updated: first_name, last_name, job_title, contact_number, nature_of_organisation, company, city and country_based.

Get all users

Returns a list of your account's users.

Get all unsubscribed users

Retrieves all unsubscribed users from communications.

Get all subscribed users

Retrieves all subscribed users to communications.



Get all licenses

Returns a list of your account's licenses.



Get all contacts

Returns a list of your account's contacts.