Using the API

Errors

Markdown

Error format and status codes.

The API uses standard HTTP status codes. Every error response has the same shape:

{
  "error": {
    "code": "not_found",
    "message": "Brand not found",
    "requestId": "e5813d25-a1e8-4338-8f21-953f3a8914ff"
  }
}
FieldDescription
codeA stable, machine-readable error code. Use it in your code instead of message.
messageA human-readable explanation. The wording may change.
requestIdA unique id for the request. Include it when you contact support.

Error codes

StatusCodeWhat to do
400invalid_requestA parameter is missing or invalid. The message says which one.
401unauthorizedCheck that the API key is correct and has not been deleted.
403plan_requiredChoose a plan for the workspace in Settings → Billing & plans.
404not_foundThe resource does not exist, or it belongs to a different workspace.
429rate_limitedWait for the seconds in the Retry-After header, then retry. See Rate limits.
500internal_errorSomething went wrong on our side. Retry with exponential backoff. If it keeps happening, contact support with the requestId.

Unknown query parameters are rejected with 400 invalid_request, so a typo in a parameter name does not silently return unfiltered data.

On this page