---
title: "Search Workflows"
method: POST
path: "/app/v1/workflows/search"
tags: ["workflows"]
---

# Search Workflows

`POST /app/v1/workflows/search`

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'status' | 'created_at'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for Workflow where it can filter based on any of these following fields. No fields are mandatory and the syntax is roughly the same as MongoDB querying.
    - `facility.custom_attributes` object
    - `facility.id` string
    - `facility.name` string
    - `facility.status` string
    - `id` string, uuid
    - `name` string
    - `description` string
    - `workflow_template_id` string, uuid
    - `status` 'complete' | 'in_progress' | 'overdue' | 'dismissed' | 'missed'
    - `created_by` string, uuid
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `due_date` string, date-time
    - `workflow_category.id` string, uuid
    - `workflow_category.name` string
    - `workflow_template.name` string
    - `workflow_template.status` 'active' | 'draft' | 'archive'
    - `workflow_template.description` string

## Response `200`

Successfully operation

- PagedWorkflowList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` IWorkflow[]
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, required
    - `company_id` string, uuid, required
    - `workflow_template_id` string, uuid, required
    - `status` 'complete' | 'in_progress' | 'overdue' | 'dismissed' | 'missed' | 'error', required
    - `config` object, required
      - `start` string, required
      - `steps` object, required
      - `workflow_name` string
      - `workflow_description` string
    - `variables` object, required
    - `step_states` object, required
    - `due_date` union, required
      - string
      - string, date-time
    - `notification_date` union
      - string
      - string, date-time
    - `created_at` union, required
      - string
      - string, date-time
    - `updated_at` union, required
      - string
      - string, date-time
    - `created_by` string, uuid, required
    - `updated_by` string, uuid, required

---

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