An API key (apy_*) is your party’s server-side credential. Its secret starts with sk_ntl_, and a request made with it acts as your party, limited to the key’s scopes. To learn more, see Authentication.
The object is everything inside data. The field names below are relative to it: attributes.apiKeyPrefix is data.attributes.apiKeyPrefix in the response.
Fields
string
required
Resource type. Always apiKey.
string
required
API key ID (apy_*).
object
required
The API key’s details.
Hide attributes
string
required
Non-secret prefix of the API key, e.g. sk_ntl_prod_abc123.
string
required
API key name.
string[]
required
Scopes granted to this key.
string
required
Environment the key authenticates in: sandbox or prod. One of: sandbox, prod.
string
required
API key status. One of: ACTIVE, REVOKED, UNKNOWN. See Statuses.
string
required
RFC 3339 timestamp when this key was created.
string | null
required
RFC 3339 timestamp when this key was last used, or null when never used.
string | null
required
RFC 3339 timestamp when this key was revoked, or null while active.
string | null
required
User who created this key (usr_*).
string | null
required
User who revoked this key (usr_*).
object
required
Metadata visible to anyone who can read the resource.
object
required
Related resources, each by type and ID.
Hide relationships
object
required
Party that owns the API key.
Hide party
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always party.
string
required
ID of the party that owns the API key (pty_*).
Statuses
Status
Meaning
Can become
ACTIVE
The key can authenticate. Every new key starts here.
REVOKED
REVOKED
You revoked the key, or the account was closed. It can’t authenticate again.
Final
UNKNOWN
Not returned today. Reserved for a status Natural adds later.
Final
Events
This resource sends no webhook events.
Endpoint differences
These endpoints return the object with a difference:
POST /api-keys also returns the plaintext apiKey, the only time it is shown.