Success codes
The request was successful and the server returned the requested data.
The request was successful and a new resource was created. Returned for POST requests that create new resources.
The request was successful but there is no content to return. Typically returned for DELETE operations.
Error codes
There was an issue with the request. This usually indicates malformed JSON,
missing required parameters, or invalid parameter values.
The request needs to be authenticated. This typically means:
- Missing API key.
- Invalid API key.
- Expired API key.
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.
The requested URL or resource was not found. This could indicate:
- Incorrect endpoint URL.
- Resource ID doesn’t exist.
- Workspace subdomain is incorrect.
The given request could not be processed by the server due to malformed
request. Check the request body once again.
Rate limit exceeded. Try again after some time.
An unexpected error occurred on the server. If this persists, please contact
support.
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:401 Unauthorized
string
A human-readable error message.