apiKeyManagement

List API Users

List the API users in your company. Superadmins only. An API user is the service account that API keys are issued to; each key's userId points to one.

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

get/api-users

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/api-users
  • 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 users

idinteger

API user ID. Pass it to POST /api-users/{user_id}/archive.

emailstring email
firstNamestring
lastNamestring
isActiveboolean nullable

Whether the API user is active in this company. false once archived.

lastSeenAtstring date-time nullable

When this API user last made a request, accurate to about an hour. null if it has never been used. Tracked per API user, not per key.

createdAtstring date-time

Changes

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