Skip to main content
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.

Example

GET /api-keys/{keyId}
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.
object
required
Related resources, each by type and ID.

Statuses

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.

Errors

See the error codes these endpoints return.

Sandbox simulations

None.