ApiKey

object

idrequired: Id
Opaque record id.
namerequired: string
prefixrequired: string
First characters of the key, to tell keys apart.
scopesrequired: array of string
created_byrequired: object or null
created_by.idrequired: Id
Opaque record id.
created_by.namerequired: string
statusrequired: "active" | "expired" | "revoked"
last_used_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
expires_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
revoked_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "name": "string",
  "prefix": "string",
  "scopes": [
    "string"
  ],
  "created_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "status": "active",
  "last_used_at": "2026-10-06T05:30:00.000Z",
  "expires_at": "2026-10-06T05:30:00.000Z",
  "revoked_at": "2026-10-06T05:30:00.000Z",
  "created_at": "2026-10-06T05:30:00.000Z"
}