RoundPlanAPI reference
v1OpenAPI 3.1 ↗Get an API key

Account

Retrieve the agency

GET/api/v1/agencyScope any key

The agency the key belongs to: its name, logo and colour, which is what a client-facing app needs to brand itself.

Query parameters

No parameters.

Returns

An Agency object.

object"agency"
idstring
Unique id of the agency.
namestring
The agency's trading name.
slugstring
The agency's short name in RoundPlan.
taglinestring or null
The line under the agency's name on its client pages.
logo_urlstring or null
The agency's logo.
contact_emailstring
The agency's public contact email.
default_currencystring or null
The currency the agency usually quotes in, ISO 4217.
accent_colorstring or null
The colour the agency's client pages use. Null = RoundPlan's default.

Errors

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.