List Workflows

Retrieve a paginated list of your workflows, including their approvals. Workflows allow to pack approvals together and easily request them.

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 responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today's date.

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

Example:

"2026-03-03"

Query Parameters

pageIndex · number · default: 0

Page number

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: CONSENT, FORM, DOCUMENT, JSON, PAYMENT, POLICY

Example:

["DOCUMENT", "CONSENT"]

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

data · object[] · required

Array of yourgroups 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