The API Keys object

An API key bound to an organisation with scoped permissions.

Attributes

idstring
Integer identifier for the key record.
keyPreviewstring
Masked key showing prefix and last 4 characters: sk_live_...Ab3x.
namestring
Optional human-readable label for the key.
environmentstring
Either live or test. Determines the key prefix.
scopesstring
Array of permission scopes granted to this key.
scopesSummarystring
Human-readable description of the effective permissions.
createdAtstring
ISO 8601 timestamp of key creation.
lastUsedAtstring
ISO 8601 timestamp of the most recent authenticated request, or null.
revokedAtstring
ISO 8601 timestamp of revocation, or null if active.
graceExpiresAtstring
ISO 8601 timestamp when the rotation grace period ends, or null.
replacedBystring
ID of the replacement key if this key was rotated, or null.
isActivestring
True if the key can authenticate requests (not revoked, grace not expired).
isRotatingstring
True if the key is in a rotation grace period.