Overview
Responses and errors
A success is { "data": ... }, and a list adds "nextCursor". An error is { "error": { "type", "code", "message", "requestId" } }. Every response carries x-request-id; quote it when asking for help.
- 400
unknown_parameter: A query parameter this endpoint does not take; usually a typo - 400
invalid_limit:limitis not a whole number in range - 400
invalid_cursor:cursoris not one this API returned - 400
invalid_status:statusis not one of the listed values - 400
invalid_from:fromis not an ISO 8601 date or time - 400
invalid_to:tois not an ISO 8601 date or time - 400
invalid_locationId:locationIdis not a valid id - 401
invalid_api_key: Missing, malformed, unknown, revoked or wrong. Deliberately one answer for all of them - 402
api_access_required: The business's API Access addon is not active - 403
insufficient_scope: The key does not have the permission this endpoint needs - 404
not_found: No such record at this business - 429
rate_limited: Too many requests; waitretry-afterseconds - 429
daily_budget_exhausted: Today's read budget is spent; it resets at 00:00 UTC - 500
internal_error: Ours. Retry later, and quote the requestId if it persists
Fields are added within v1 without notice, so ignore fields you don't recognise. Anything that would break you becomes v2.
Was this helpful?