API Response
Standard API Response Format
Section titled “Standard API Response Format”Most API endpoints return responses in a standardized JSON format, no matter what Accept header is passed in the API request. This ensures consistency across the entire API and makes it easier to handle responses in your application.
codeintegerRequiredResponse code
messagestringRequiredResponse message
dataobject | arrayResponse data
paginationobjectPagination information
page_sizeintegerRequiredPage size
pageintegerRequiredCurrent page
total_itemsintegerTotal items
Success Response
Section titled “Success Response”When an API request is successful:
- HTTP Status Code: Usually
200 OK, can be201 Createdfor endpoints that create resources code: Always0for successful responsesmessage: AlwaysOKfor successful responsesdata: Contains the actual response data, structure varies by endpoint
Error Response
Section titled “Error Response”When an API request fails:
- HTTP Status Code: Varies based on error type (4xx or 5xx)
code: Non-zero error code (see response codes table below)message: Human-readable error description
Response Codes
Section titled “Response Codes”| Code | Description |
|---|---|
| 0 | Success |
| 1 | Internal error |
| 2 | Route not found |
| 4 | Authentication method not allowed |
| 5 | Resource not found |
| 6 | One of our backend services is unavailable |
| 11 | Too many requests |
| 1000 | Invalid parameters |
| 1001 | Invalid JSON body payload |
| 1002 | Invalid upload payload |
| 2000 | Unauthenticated |
| 2001 | Invalid auth header |
| 2002 | Invalid token format |
| 2100 | Invalid OAuth code |
| 2101 | Invalid OAuth state |
| 2200 | Unauthorized |
| 2201 | Unauthorized, missing required token scope |
| 2202 | Unauthorized, missing required organization member scope |
| 3000 | User not found |
| 3200 | Notification not found |
| 3201 | Notification already read |
| 3500 | Organization not found |
| 3501 | Organization slug already used |
| 3502 | Organization exceeds limit |
| 3600 | Organization member not found |
| 3601 | Organization member already exists |
| 4000 | Token not found |
| 5000 | Project not found |
| 5001 | Project already used |
| 5002 | Unacceptable project slug |
| 5003 | Project locked |
| 5100 | Project keyword not found |
| 5101 | Project keyword already exists |
| 5102 | Project keyword exceeds limit |
| 5200 | Project channel not found |
| 5201 | Project channel already exists |
| 5202 | Project channel exceeds limit |
| 5300 | Project version not found |
| 5301 | Project version already exists |
| 5400 | Invalid project dependency |