Asana · Schema

Error

CollaborationProductivityProject ManagementProjectsTask ManagementTasksWorkflow

Properties

Name Type Description
message string Message providing more detail about the error that occurred, if available.
help string Additional information directing developers to resources on how to address and fix the problem, if available.
phrase string *500 errors only*. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana’s logs.
View JSON Schema on GitHub

JSON Schema

asana-error-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Error",
  "title": "Error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "readOnly": true,
      "description": "Message providing more detail about the error that occurred, if available.",
      "example": "project: Missing input"
    },
    "help": {
      "type": "string",
      "readOnly": true,
      "description": "Additional information directing developers to resources on how to address and fix the problem, if available.",
      "example": "For more information on API status codes and how to handle them, read the docs on errors: https://asana.github.io/developer-docs/#errors'"
    },
    "phrase": {
      "type": "string",
      "readOnly": true,
      "description": "*500 errors only*. A unique error phrase which can be used when contacting developer support to help identify the exact occurrence of the problem in Asana\u2019s logs.",
      "example": "6 sad squid snuggle softly"
    }
  }
}