authentication

Get API Key

Obtain an API key using Basic Authentication. This key will be used for all other API requests.

For a user belonging to multiple companies, pass company_id to select which company the new key belongs to. If omitted, the company is chosen deterministically: the user's first non-collaborator company, or otherwise their first company.

Your company ID can be found in the URL after logging in to the Coperniq UI: https://app.coperniq.io/{company_id}/inbox.

post/api-keys

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/api-keys
  • Auth: HTTP basic

Query parameters

company_idinteger

ID of the company the new API key should belong to. Required only when the authenticated user belongs to more than one company and the default (first non-collaborator company) is not the desired one. The user must belong to the given company. Your company ID can be found in the URL after logging in to the Coperniq UI: https://app.coperniq.io/{company_id}/inbox.

Response

API key generated successfully

tokenstring

API key (token) for authenticating future requests

companyIdinteger

Company identifier

descriptionstring

Description of the API key

namestring

Name of the API key

emailstring email

Email address of the user who created the API key

idinteger

API user identifier

Changes

No recorded changes to this operation across all 1 revision of this API.