List statuses

v1.0.0

Lists all statuses for a particular status attribute on either an object or a list.

When target is objects, the required scopes are object_configuration:read. When target is lists, the required scopes are list_configuration:read.

Input

{
  "type": "object",
  "properties": {
    "attribute": {
      "type": "string",
      "description": "A UUID or slug to identify the attribute you want to list statuses on."
    },
    "identifier": {
      "type": "string",
      "description": "A UUID or slug to identify the object or list the status attribute belongs to."
    },
    "show_archived": {
      "type": "boolean",
      "description": "`true` if you want the results to include archived statuses. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving."
    },
    "target": {
      "type": "string",
      "description": "Whether the attribute is on an object or a list.",
      "enum": [
        "lists",
        "objects"
      ]
    }
  },
  "required": [
    "attribute",
    "identifier",
    "target"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "title",
          "is_archived",
          "celebration_enabled",
          "target_time_in_status"
        ],
        "properties": {
          "celebration_enabled": {
            "type": "boolean",
            "description": "Whether arriving at this status triggers a celebration effect in the UI"
          },
          "id": {
            "type": "object",
            "required": [
              "workspace_id",
              "object_id",
              "attribute_id",
              "status_id"
            ],
            "properties": {
              "attribute_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the attribute"
              },
              "object_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the object"
              },
              "status_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the status"
              },
              "workspace_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the workspace"
              }
            }
          },
          "is_archived": {
            "type": "boolean",
            "description": "Whether or not to archive the status. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving."
          },
          "target_time_in_status": {
            "type": [
              "string",
              "null"
            ],
            "description": "Target time for a record to spend in given status expressed as a ISO-8601 duration string"
          },
          "title": {
            "type": "string",
            "description": "The title of the status"
          }
        }
      }
    }
  }
}