List workflows

get
https://api.box.com/2.0
/workflows

Returns list of workflows that act on a given folder ID, and have a flow with a trigger type of WORKFLOW_MANUAL_START.

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

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

stringin queryrequired
"12345"

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123.

The root folder of a Box account is always represented by the ID 0.

integer / int64in queryoptional
10001000

The maximum number of items to return per page.

stringin queryoptional
"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

stringin queryoptional
"WORKFLOW_MANUAL_START"

Type of trigger to search for.

Response

application/jsonWorkflows

Returns the workflow.

application/jsonClient error

Returned if the trigger type is not WORKFLOW_MANUAL_START.

application/jsonClient error

Returned if the folder is not found, or the user does not have access to the folder.

application/jsonClient error

An unexpected client error.

get
List workflows
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/workflows?folder_id=324234" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

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": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}