API reference

API reference · Keys

List API keys

GET/api/keysSigned in session

Parameters

Path and query parameters
FieldTypeWhat it is
orgId (query)integerAn organization's keys instead of your own.

Answer 200

Keys by prefix. Plaintext is never returned again.

Fields of the 200 answer
FieldTypeWhat it is
keysarray of ApiKey
keys[].idinteger
keys[].namestring
keys[].prefixstringThe first twelve characters, for display.
keys[].createdAtinteger
keys[].revokedAtinteger or null
keys[].lastUsedAtinteger or null
keys[].scopesarray of KeyScope
keys[].expiresAtinteger or nullUnix ms, or null for no expiry.
keys[].ipAllowlistarray of string
keys[].orgIdinteger or nullSet when the key belongs to an organization.
keys[].rotatedFrominteger or nullThe key this one replaced.
keys[].graceUntilinteger or nullSet on a rotated key; it stops working here.
Antimatter