Skip to navigation
API KeyAPI Key Management

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.

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 users
idintegerOptional

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

emailstringOptionalformat: "email"
firstNamestringOptional
lastNamestringOptional
isActiveboolean or nullOptional

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

lastSeenAtstring or nullOptionalformat: "date-time"

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.

createdAtstringOptionalformat: "date-time"

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error