Skip to main content
GET
Get the authenticated viewer
Calling this endpoint is free — it never consumes API credits, so you can use it to verify a credential during integration setup or on a health check. API key responses include the key’s current credit usage, matching the x-api-key-quota and x-api-key-approximate-usage headers returned by billable endpoints.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

The presented credential is valid. The type property indicates which kind of credential authenticated the request and determines the response shape.

The authenticated API key.

type
enum<string>
required

The kind of credential that authenticated the request.

Available options:
api-key
id
string
required

Id of the API key.

urn
string
required

URN of the API key, e.g. urn:brandfetch:organization:{organization.id}:api-key:{id}.

name
string | null
required

Display name of the API key, as set in the dashboard.

createdAt
string<date-time> | null
required

When the API key was created.

usage
object
required

API credit consumption for the current billing period, mirroring the x-api-key-quota and x-api-key-approximate-usage response headers of billable endpoints. Because this endpoint is free, used is the exact count — it is not approximated one ahead like the header.

organization
object
required

The organization the API key belongs to.