Account

Retrieve the current key

GET/api/v1/keyScope any key

Returns the key making the call: its name, its agency and what it can read. A good first call to check a key works.

Query parameters

No parameters.

An ApiKey object.

object"api_key"

idstring

Unique id of the key.

namestring

The name the owner gave the key in Settings.

prefixstring

The first characters of the key, to tell keys apart.

created_attimestamp

When it was created. ISO 8601, UTC.

scopesarray of string

Effective scopes, implications included.

agencyobject

The agency the key belongs to.

+ Show 2 child attributes

idstring

namestring

401unauthorizedNo key, a malformed one, or a key that does not exist or was revoked. Send it as Authorization: Bearer <key>.

403api_not_enabledRoundPlan has not turned on API access for this agency.

403subscription_inactiveThe agency's trial expired or its subscription ended.

429rate_limitedToo many requests. Wait the seconds in Retry-After. See Errors and rate limits.

500internal_errorSomething went wrong on our side. Retry later.