​
Success Codes

​
200 OK
The request was successful and the server returned the requested data.

​
Client error codes

​
400 Bad Request
There was an issue with the request. This usually indicates malformed JSON, missing required parameters, or invalid parameter values.
​
401 Unauthorized
The request needs to be authenticated. This typically means:
  • Missing API key.
  • Invalid API key.
  • Expired API key.
​
403 Forbidden
An operation was not allowed. This could mean:
  • Insufficient permissions for the requested action.
  • Attempting to access a resource you don’t own.
  • API key doesn’t have the required scope.
​
404 Not Found
The requested URL or resource was not found. This could indicate:
  • Incorrect endpoint URL.
  • Resource ID doesn’t exist.
  • Workspace subdomain is incorrect.
​
422 Unprocessable entity
The given request could not be processed by the server due to malformed request. Check the request body once again.

​
Server Error Codes

​
500 Internal Server Error
An unexpected error occurred on the server. If this persists, please contact support.
​
501 Not Implemented
The server does not support the functionality required to fulfill the request.

​
Error Response Format

When an error occurs, the API returns a JSON response with error details:
Error Response Example
{
  "message": "The provided API key is invalid or expired"
}
​
error.message
string
A human-readable error message.
When debugging API issues, the HTTP status code often provides the first clue about what went wrong. Start by checking the status code before diving into the response body.