Box Developer Documentation
Log in

Workflows

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

A list of workflows.

You application must be authorized to use the Manage Box Relay application scope within the developer console in order to use this resource.

Workflow array

A list of workflows

integer (int64)
1000

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

string
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

The marker for the start of the next page of results.

string
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih

The marker for the start of the previous page of results.

Response Example

{
  "entries": [
    {
      "description": "This workflow sets off a new hire approval flow",
      "id": "11446498",
      "is_enabled": true,
      "name": "New Hire Workflow",
      "type": "workflow",
      "flows": [
        {
          "created_at": "2012-12-12T10:53:43-08:00",
          "created_by": {
            "id": "11446498",
            "type": "user"
          },
          "id": "12345",
          "outcomes": [
            {
              "action_type": "assign_task",
              "id": "12345",
              "if_rejected": [
                {
                  "action_type": "assign_task",
                  "id": "12345",
                  "name": "Approval Rejection Outcome",
                  "type": "outcome"
                }
              ],
              "name": "Task Approval Outcome",
              "type": "outcome"
            }
          ],
          "trigger": {
            "scope": [
              {
                "object": {
                  "id": "12345",
                  "type": "folder"
                },
                "ref": "/event/source/parameters/folder",
                "type": "trigger_scope"
              }
            ],
            "trigger_type": "WORKFLOW_MANUAL_START",
            "type": "trigger"
          },
          "type": "flow"
        }
      ]
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}