Error Handling
The API uses standard HTTP status codes and returns errors as JSON.
Error Format
{
"error": "Description of the error"
}For validation errors, additional details are included:
{
"error": "Invalid input",
"details": [
{ "path": ["expiresAt"], "message": "expiresAt must be in YYYY-MM-DD format" }
]
}Status Codes
| Code | Meaning |
|---|---|
200 | Success |
201 | Created |
204 | Deleted (no content) |
400 | Bad request — invalid input or missing fields |
401 | Unauthorized — missing, invalid, or expired API key, or plan without API access |
404 | Not found — item does not exist or belongs to a different workspace |
429 | Rate limit exceeded — wait and retry |
503 | Maintenance mode — the platform is temporarily unavailable (includes Retry-After header) |
Last updated on