Skip to content

Errors

The API uses standard HTTP status codes and a consistent error envelope, so you can handle every failure the same way.

Errors share the response envelope but carry a message instead of data:

{
"success": false,
"statusCode": 403,
"code": "invalid_api_key",
"message": "API key is invalid or missing to access to the requested resource"
}
FieldTypeDescription
successbooleanAlways false for errors.
statusCodeintegerMirrors the HTTP status code.
codestringStable, machine-readable error code.
messagestringHuman-readable explanation.

Branch on success (or statusCode) rather than parsing the message text:

const body = await res.json();
if (!body.success) {
// body.code is stable; body.message is for humans/logs
throw new Error(`${body.code}: ${body.message}`);
}
StatusTypical codeMeaning
403invalid_api_keyToken missing or invalid — see Authentication.
404not_foundThe requested resource does not exist.

Request API access

Tell us a little about your integration and we'll get back to you within one business day with a partner token.