OKR Authentication

Generating an API token

1. From the OKR module, go to the Settings page > API page, click +Generate new token.

   

2. Click the Generate new token button in the top right corner of the page.

3. Give the token a name and click Create.

4. Copy the generated API token and store it securely, as you won't be able to retrieve it later.

Authentication

All requests made to the BigPicture OKR module API require authentication using your generated API token. This is achieved by including an API-Token header in your requests. If the header is not present, you will receive a 400 Bad Request response.

Note: Please make sure you use the API-Token header, not the Authentication header.

API administrator table

BigPicture OKR module enables you to oversee all API tokens created within your organization. Users with the API_ADMIN_TABLE_ACCESS permission have access to an expanded view on the API settings page. The API administrator table allows you to see, rename, or revoke any token within your organization.