Box Developer Documentation
Log in

Workflows

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
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.

integer / int64
3000

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

integer / int64
1000

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

Response Example

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