Skip to navigation
API KeyAPI Key Management

List API Keys

List the API keys in your company. Superadmins only.

The key values are never returned. Each key’s id is a non-secret fingerprint; use it to delete the key with DELETE /api-keys/{key_id}, and use keyPreview (the key’s last 4 characters) to recognize it.

Authenticate with Basic Auth (your Coperniq email and password), not an API key.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

company_idintegerOptional>=1

ID of the company to manage. Needed only when the authenticated user belongs to more than one company and the default (their first non-collaborator company) is not the one you want. You must be a superadmin in that 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

The company's API keys
idstringOptionalformat: "^key_[0-9a-f]{24}$"

Non-secret identifier for the key. Pass it to DELETE /api-keys/{key_id}.

keyPreviewstringOptional
The last 4 characters of the key, masked, so you can recognize which key this is.
namestringOptional
Name of the API key
descriptionstring or nullOptional
Description of the API key
userIdintegerOptional

ID of the API user (service account) the key belongs to

createdByIdinteger or nullOptional
ID of the user who created the key
isEnabledbooleanOptional
Whether the key is enabled
createdAtstringOptionalformat: "date-time"
updatedAtstringOptionalformat: "date-time"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error