Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

A merchant standard (sk_…) or restricted (rk_…) secret key sent as Authorization: Bearer <key>.

Path Parameters

id
string
required

The API key identifier (sk_… for secret keys, pk_… for publishable keys).

Response

The API key. The full key value is not included.

Standard read view of an API key. Does not include the full authenticatable token — only the key_prefix for identification.

id
string
required

Unique resource identifier. sk_… for secret keys; pk_… for publishable keys.

key_prefix
string
required

First 19 characters of the full key. Used to identify the key without exposing the secret.

key_type
enum<string>
required

secret for server-side keys; publishable for client-side keys.

Available options:
secret,
publishable
mode
enum<string>
required

Environment scope this key operates in.

Available options:
test,
live
status
enum<string>
required

active means the key can authenticate requests. revoked means it has been permanently disabled.

Available options:
active,
revoked
owner_type
enum<string>
required

Whether this key belongs to a merchant or a platform.

Available options:
merchant,
platform
owner_id
string
required

Identifier of the owning merchant or platform.

permissions
string[]
required

Permission scopes granted to this key.

created_at
integer
required

Unix epoch seconds when the key was created.

updated_at
integer
required

Unix epoch seconds when the key was last updated.

access_profile
enum<string>

Authorization policy for secret keys. Omitted for publishable keys and for temporarily unclassified legacy rows during rollout.

Available options:
standard,
restricted
name
string | null

Display name, if set.

description
string | null

Notes, if set.

expires_at
integer | null

Unix epoch seconds when the key expires. Null if the key does not expire.