---
title: "Gets a list of workflows"
method: POST
path: "/api/v{version}/workflows/search"
tags: ["orders"]
---

# Gets a list of workflows

`POST /api/v{version}/workflows/search`

Gets a list of workflows with pagination and filtering support

## Path parameters

- `version` string, required

## Headers

- `X-Tenant` string, required

## Request body

- SearchWorkflowsRequest
  - `advancedSearch` Search
    - `fields` string[], nullable
    - `keyword` string, nullable
  - `keyword` string, nullable
  - `advancedFilter` Filter
    - `logic` string, nullable
    - `filters` Filter[], nullable
    - `field` string, nullable
    - `operator` string, nullable
    - `value` unknown
  - `pageSize` integer
  - `pageNumber` integer
  - `orderBy` string[], nullable
  - `expiration` string, date-span, nullable

## Response `200`

OK

- PagedListWorkflowResponse
  - `items` WorkflowResponse[], nullable
    - `id` string, uuid
    - `name` string, nullable
    - `isDefault` boolean
    - `states` StateResponseDto[], nullable
      - `id` string, uuid
      - `name` string, nullable
      - `description` string, nullable
      - `ranking` integer
      - `visibleFor` 0 | 1 | 2 | 4 | 8
      - `editableBy` 0 | 1 | 2 | 4 | 8
      - `color` string, nullable
      - `requirements` string[], nullable
      - `transitions` TransitionResponseDto[], nullable
        - `id` string, uuid
        - `actionName` string, nullable
        - `fromStateId` string, uuid
        - `toStateId` string, uuid
      - `situations` SituationResponseDto[], nullable
        - `id` string, uuid
        - `name` string, nullable
        - `slug` string, nullable
        - `description` string, nullable
        - `order` integer
        - `requirements` string[], nullable
        - `metadataType` string, nullable
        - `metadataConfiguration` unknown
  - `pageNumber` integer
  - `pageSize` integer
  - `totalCount` integer
  - `totalPages` integer
  - `hasPrevious` boolean
  - `hasNext` boolean

---

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