Docs

List API Keys

Audit your API keys: when each was last used and which have been revoked. Key material is never returned.

GET

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more
string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more
number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more
string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Response fields

idstring

Unique id of the key.

namestring

The name the key was created with.

companyIdstring

The organization the key belongs to. A key with isAllOrganizations is listed in every organization its creator opens, so it may belong to another one.

isAllOrganizationsboolean

"Use this key across all of your organizations": the key can act, through X-Company-Id, in every organization its creator can open in the app, with no more than the creator may do there.

accessLevelstring

A summary of the key permissions: full_access, run_workflows, read_only, or none. Derived from permissions; it is never set directly.

  • read_only
  • run_workflows
  • full_access
  • none
permissionsarray of string

The permissions the key holds. A request may use one only while the key's creator also holds it.

usedOndate

The last time the key was used. Old dates are rotation candidates.

revokedOndate

When the key was revoked. Empty while it is active.

createdOndate

When the key was created.

createdBystring

Who created it.

updatedOndate

When it was last changed.