Nuclino uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted). Codes in the 5xx range indicate an error with Nuclino's servers.
Example of a successful 200 response:
{
"status": "success",
"data": {
"object": "team",
"id": "0637c6dd-779c-466a-9fe7-ae4da19b98f2",
}
}Example of a 4xx error response:
{
"status": "fail",
"message": "Not found"
}Example of a 5xx error response:
{
"status": "error",
"message": "Unexpected server error"
}Code | Meaning |
| The request is malformed, e.g. a required parameter is missing or has the wrong type. The |
| The API key is missing or invalid. |
| The user the API key belongs to does not have the required access, e.g. edit access to modify an item. |
| The requested object does not exist or is not accessible to the user the API key belongs to. |
| The |
| The request body exceeds the maximum size of 100 KB. |
| The request is well-formed but cannot be applied, e.g. an invalid field value or moving a collection into itself. |
| The rate limit was exceeded (see Rate limiting). |
All objects have an object and a unique id attribute. Example of a team object:
{
"object": "team",
"id": "161018ac-3134-49dd-b540-8c75e4a2ebef",
"name": "Awesome Team",
}All dates use the ISO 8601 format:
"2021-01-20T18:20:00.000Z"