List workflows
GET https://{{api.box.com}}/2.0/workflows?folder_id=12345
Returns list of workflows that act on a given folder ID, and
https://developer.box.com/reference/get-workflows
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
folder_id | number | 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
. |
| trigger_type
| string | | Type of trigger to search for. |
| limit
| number | | The maximum number of items to return per page. |
| marker
| string | | 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
. |
RESPONSES
status: OK
{"limit":1000,"next_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","prev_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","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"}}]}]}