Box Developer Documentation
 
    Latest version

    List workflows

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

    This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

    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 (int64)in queryoptional
    1000
    1000

    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": [
        {
          "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"
    }