apiKeyManagement

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.

get/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 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

idstring

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

keyPreviewstring

The last 4 characters of the key, masked, so you can recognize which key this is.

namestring

Name of the API key

descriptionstring nullable

Description of the API key

userIdinteger

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

createdByIdinteger nullable

ID of the user who created the key

isEnabledboolean

Whether the key is enabled

createdAtstring date-time
updatedAtstring date-time

Changes

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