Skip to content

Errors

The API uses standard HTTP status codes and returns error details as JSON.

HTTP status codes

Code Meaning
200 OK Request succeeded
204 No Content Request succeeded; no response body (used for updates and deletes)
400 Bad Request Invalid request body or parameters
401 Unauthorized Missing, invalid, disabled, or expired API key
403 Forbidden Valid key but insufficient permissions
404 Not Found Resource does not exist
429 Too Many Requests Rate limit exceeded (future)
500 Internal Server Error Something went wrong on our end

Error format

Error responses return a JSON object with an error field:

{
  "error": "Vendor not found"
}

For validation errors, the response may include field-level details:

{
  "name": "This value should not be blank."
}

Common errors

Invalid API key

HTTP/1.1 401 Unauthorized
{
  "error": "Invalid API key"
}

Make sure you're sending the key in the X-API-Key header (not Authorization).

Expired or disabled key

HTTP/1.1 401 Unauthorized
{
  "error": "API key is disabled or expired"
}

Ask your company admin to check the key status or create a new one.

Resource not found

HTTP/1.1 404 Not Found
{
  "error": "Vendor not found"
}

Verify the unique ID in the URL path is correct.