Viewer API
Returns the identity of the credential used to authenticate the request — an API key or a user session token (JWT). Use it to verify a credential during integration setup (a 200 response means the credential is valid; 401/403 means it is missing, unknown, or revoked) and to display which API key and organization are connected. Requests to this endpoint are free: they never consume API credits.
usage, matching
the x-api-key-quota and x-api-key-approximate-usage headers returned by
billable endpoints.Authorizations
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.
- API key
- User
The authenticated API key.
The kind of credential that authenticated the request.
api-key Id of the API key.
URN of the API key, e.g. urn:brandfetch:organization:{organization.id}:api-key:{id}.
Display name of the API key, as set in the dashboard.
When the API key was created.
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.
The organization the API key belongs to.