List Workflows

Retrieve a paginated list of your workflows, including their approvals. Workflows let you pack approvals together and request them easily. Filter with the optional query parameters: search (matches the workflow name or the name of a contained approval), active (active or inactive workflows only), types (only workflows containing approvals of the given resource types), and internalId (only the workflow containing the approval with your identifier). Use pageIndex and pageSize to paginate.

GET /approvals/workflow

List Workflows

cURL

curl --request GET \
  --url https://api.example.com/approvals/workflow

200

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Onboarding Resources",
      "active": true,
      "resources": [
        {
          "id": "507f1f77bcf86cd799439011",
          "name": "Identity Document",
          "type": "DOCUMENT",
          "active": true,
          "internalId": "internal-12345"
        }
      ],
      "updatedAt": "2025-01-15T10:30:00Z",
      "description": "Resources required for employee onboarding"
    }
  ],
  "totalPages": 5
}

Headers

API-Version · string

Pin request, response, and webhook shapes to a specific dated API version (YYYY-MM-DD). Omit to use the version pinned to your API key (set when the key is created; new keys default to the latest version). New integrations should target the latest version.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-09-01"

Query Parameters

pageIndex · number · default: 0

Zero-based page index. 0 returns the first page.

Example:

0

pageSize · number · default: 10

Number of items per page

Required range: 5 <= x <= 100

Example:

10

search · string

Search query to filter by. Is case-insensitive and does not need to match the entire value.

Maximum string length: 100

Example:

"example"

active · boolean

Filter by active status. Accepts true/false as string or boolean.

Example:

true

types · enum<string>[]

Filter by resource types. Can be a single value or array

Available options: DOCUMENT, FORM, JSON, POLICY

Example:

["DOCUMENT", "FORM"]

internalId · string

Identifier to help you identify the resource in your own system. We recommend using a unique value.

Example:

"internal-12345"

Response

200 - application/json

Returns an array of workflows (each including its approvals) and the total number of pages.

data · object[] · required

Array of your groups matching the query parameters

Show child attributes

totalPages · number · required

Total number of pages available based on the page size and total count

Example:

5