Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
workflows

Api Workflows List List

List workflows with filtering support.

GET /api/workflows/list/ — paginated list with filters_data POST /api/workflows/list/ — POST-for-filtering (not creation)

get/api/workflows/list/

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

Free-text search over workflow name.

sort_bystring

Field to sort by, e.g. '-updated_at'.

trigger_event_typestring

Filter by trigger event type, e.g. 'eval_only'.

typestring

Workflow type filter (automations, monitors, evaluators, reports).

Headers

Authorizationstring required

JWT access token or Respan API key

Response

countinteger required
nextstring uri nullable
previousstring uri nullable
total_countinteger
current_filtersFilterParamDictPydantic

Pydantic model for FilterParamDict. A dictionary that maps metric names to their filter parameters.

Each key is a metric name (str), and each value can be:

  • A single MetricFilterParamPydantic (one condition)
  • A List[MetricFilterParamPydantic] (multiple conditions for same metric)
  • A FilterBundlePydantic (nested filter bundle with connector)

Note: Uses extra="allow" for dynamic metric name fields. The pydantic_extra annotation tells Pydantic what types to expect for extra fields, and generates typed additionalProperties in JSON Schema.

filters_dataPaginatedWorkflowListListFiltersData