💡 Our Enterprise API is available to company admins who have active Enterprise plans with CoLab. If you can't see the API Keys section of your Settings & Admin page and believe that you should, please reach out to your CSM.
The first step to using CoLab's enterprise API is to set up an API key with appropriate permissions.
First, navigate to the Settings & Admin page by clicking on your profile picture in the bottom left of the page and selecting Settings & Admin.
Click on the API Keys section, and then on +New API Key.
Select what permissions you would like the API key you are creating will be allowed to access. Each option is given a brief explanation within this modal, and a full explanation within the broader API documentation.
Once you have selected your permissions, ensure you give a name to your API key for future reference. Optionally, select an expiry date for the API key. Select "Create" when you're ready.
Copy the API key you are given on the next page.
❗ For security purposes, this is the only time you will have access to this key. Copy it to a secure place. If you lose this, you will need to create a new API key.
The second important step to using the CoLab API is the Client ID, which serves alongside the API key to authenticate API requests and track usage.
You can find your company's Client ID at the bottom of the API Key page, with an easy-to-copy button to the right.
Disable or Delete an API Key
As API keys cannot be changed after creation, if your needs change you will need to create a new API key. We recommend disabling or deleting any API keys when they are no longer being used.
To do this, click on the three-dot kebab menu to the right of the API key in question.
API Key Authentication Example
What follows is an example of what request may look like when using your API key and Client ID:
curl --request GET \
--url https://app.colabsoftware.com/enterprise/v1/ENDPOINT_HERE \
--header 'authorization: API_KEY_HERE' \
--header 'x-client-id: CLIENT_ID_HERE'