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"
}

Object format

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",
  ...
}

Date format

All dates use the ISO 8601 format:

"2021-01-20T18:20:00.000Z"