---
title: "List workflows"
method: GET
path: "/workflows"
tags: ["Workflows"]
---

# List workflows

`GET /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.

## Query parameters

- `folder_id` string, required
- `trigger_type` string
- `limit` integer
- `marker` string

## Response `200`

Returns the workflow.

- Workflows — The part of an API response that describes marker based pagination.
  - `limit` integer — 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.
  - `next_marker` string, nullable — The marker for the start of the next page of results.
  - `prev_marker` string, nullable — The marker for the start of the previous page of results.
  - `entries` Workflow[] — A list of workflows.
    - `id` string — The unique identifier for the workflow.
    - `type` 'workflow' — The value will always be `workflow`.
    - `name` string — The name of the workflow.
    - `description` string — The description for a workflow.
    - `is_enabled` boolean — Specifies if this workflow is enabled.
    - `flows` object[] — A list of flows assigned to a workflow.
      - `id` string — The identifier of the flow.
      - `type` 'flow' — The flow's resource type.
      - `trigger` object — Trigger that initiates flow.
        - `type` 'trigger' — The trigger's resource type.
        - `trigger_type` 'WORKFLOW_MANUAL_START' — The type of trigger selected for this flow.
        - `scope` object[] — List of trigger scopes.
          - `type` 'trigger_scope' — The trigger scope's resource type.
          - `ref` string — Indicates the path of the condition value to check.
          - `object` object — The object the `ref` points to.
            - `type` 'folder' — The type of the object.
            - `id` string — The id of the object.
      - `outcomes` object[] — Actions that are completed once the flow is triggered.
        - `id` string — The identifier of the outcome.
        - `type` 'outcome' — The outcomes resource type.
        - `name` string — The name of the outcome.
        - `action_type` 'add_metadata' | 'assign_task' | 'copy_file' | 'copy_folder' | 'create_folder' | 'delete_file' | 'delete_folder' | 'lock_file' | 'move_file' | 'move_folder' | 'remove_watermark_file' | 'rename_folder' | 'restore_folder' | 'share_file' | 'share_folder' | 'unlock_file' | 'upload_file' | 'wait_for_task' | 'watermark_file' | 'go_back_to_step' | 'apply_file_classification' | 'apply_folder_classification' | 'send_notification' — The type of outcome.
        - `if_rejected` object[] — If `action_type` is `assign_task` and the task is rejected, returns a list of outcomes to complete.
          - `id` string — The identifier of the outcome.
          - `type` 'outcome' — The outcomes resource type.
          - `name` string — The name of the outcome.
          - `action_type` 'add_metadata' | 'assign_task' | 'copy_file' | 'copy_folder' | 'create_folder' | 'delete_file' | 'delete_folder' | 'lock_file' | 'move_file' | 'move_folder' | 'remove_watermark_file' | 'rename_folder' | 'restore_folder' | 'share_file' | 'share_folder' | 'unlock_file' | 'upload_file' | 'wait_for_task' | 'watermark_file' | 'go_back_to_step' | 'apply_file_classification' | 'apply_folder_classification' | 'send_notification' — The type of outcome.
      - `created_at` string, date-time — When this flow was created.
      - `created_by` object — The user who created this flow.
        - `id` string, required — The unique identifier for this user.
        - `type` 'user', required — The value will always be `user`.

## Other responses

- `400` — Returned if the trigger type is not `WORKFLOW_MANUAL_START`.
- `404` — Returned if the folder is not found, or the user does not have access to the folder.
- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)