APIKeyResponse

idstringrequired

Unique API key identifier.

namestringrequired

Human-readable name for this key.

environmentstringrequired

Key environment, live or test.

Possible values: [live, test]

permissionsPermissionScope[]required

Permission scopes granted to this key.

Possible values: [sending, emails:read, domains:manage, contacts:manage, webhooks:manage, analytics:read, api-keys:manage, suppressions:read, suppressions:manage, templates:read, templates:manage, inbound:read, inbound:manage, broadcasts:read, broadcasts:manage, broadcasts:send, *]

token_hintstringrequired

Masked token display, e.g. tix_live_...abcd1234

whitelist_ipsstring[]

Allowed IP addresses in CIDR notation.

created_atstring<date-time>required

When the key was created.

expires_atstring<date-time>nullable

When the key expires.

last_used_atstring<date-time>nullable

When the key was last used.

last_used_ipstringnullable

IP address of the last request using this key.

request_countinteger<int64>

Total number of requests made with this key.

APIKeyResponse

{
  "id": "string",
  "name": "string",
  "environment": "live",
  "permissions": [
    "sending"
  ],
  "token_hint": "string",
  "whitelist_ips": [
    "string"
  ],
  "created_at": "2024-07-29T15:51:28.071Z",
  "expires_at": "2024-07-29T15:51:28.071Z",
  "last_used_at": "2024-07-29T15:51:28.071Z",
  "last_used_ip": "string",
  "request_count": 0
}