Account
Get the account
Read the account an API key belongs to: its plan, its rate limit, and the key's own name, expiry and brand access.
/v1/accountThe account this key reads, its plan, the key's own details and its rate limit. Carries no owner name or email.
Authorization
AuthorizationstringheaderrequiredYour API key as Bearer ranqo_sk_…. The account owner creates keys in Settings, under API keys. See Authentication.
curl "https://api.ranqo.ai/v1/account" \
-H "Authorization: Bearer $RANQO_API_KEY"Sample data from an invented brand. Try it shows your own.
Response
The response body, as JSON.
account_idstringThe account this key reads.
planobjectShow 4 fields insideHide the fields inside
idstringOne of
starter,pro,business,agency,agency_scale,pilot.namestringis_trialingbooleantrial_ends_atstring or nullRFC 3339 timestamp in UTC. When the trial ends; null outside a trial.
rate_limitobjectShow 2 fields insideHide the fields inside
requests_per_minuteintegerPer key, in a fixed one-minute window.
window_secondsinteger
keyobjectShow 6 fields insideHide the fields inside
idstringnamestringmaskedstringThe key with its middle hidden, as Settings lists it.
created_atstringRFC 3339 timestamp in UTC.
expires_atstring or nullRFC 3339 timestamp in UTC. Null when the key never expires.
brand_accessobjectShow 2 fields insideHide the fields inside
all_brandsbooleanTrue when the key reads every brand, including ones added later.
brand_idsarray of stringsThe brands a restricted key reads; empty when
all_brandsis true.
Response headers
X-Request-IdThe request id; quote it to support.
RateLimitRequests left in this window and seconds until it resets.
RateLimit-PolicyThe key's limit per window.
Errors
Errors are problem details (application/problem+json) with a stable code. See Errors for each one.