Skip to main content
GET
Retrieve the calling API key

Authorizations

Authorization
string
header
required

An API key created in the dashboard, sent as Authorization: Bearer mk_....

Response

The calling API key.

The API key that authenticated the request, with its domain, organization and plan.

object
string
required

Always api_key.

Allowed value: "api_key"
key_id
string
required

The key's public identifier.

name
string
required

The key's name.

created_at
string<date-time>
required

When the key was created, in UTC.

allowed_source_ips
string[]
required

CIDR networks the key may be used from. Empty means any address.

domain
object
required

The sending domain the key belongs to.

organization
object
required

The organization that owns the domain.

plan
object | null
required

The organization's plan, or null when it has no subscription.

description
string | null

The key's description, or null.

last_auth_at
string<date-time> | null

The key's last successful authentication, in UTC, this request included. Refreshed at most every 5 minutes.