The API Keys object

An API key bound to an organisation with scoped permissions.

Attributes

id string
Integer identifier for the key record.
keyPreview string
Masked key showing prefix and last 4 characters: sk_live_...Ab3x.
name string
Optional human-readable label for the key.
environment string
Either live or test. Determines the key prefix.
scopes string
Array of permission scopes granted to this key.
scopesSummary string
Human-readable description of the effective permissions.
createdAt string
ISO 8601 timestamp of key creation.
lastUsedAt string
ISO 8601 timestamp of the most recent authenticated request, or null.
revokedAt string
ISO 8601 timestamp of revocation, or null if active.
graceExpiresAt string
ISO 8601 timestamp when the rotation grace period ends, or null.
replacedBy string
ID of the replacement key if this key was rotated, or null.
isActive string
True if the key can authenticate requests (not revoked, grace not expired).
isRotating string
True if the key is in a rotation grace period.