Sign in

v3

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

Api Workflows List

List and create workflows.

Each task in the tasks array may include an id field (string). If omitted, the server assigns a UUID automatically before saving.

PUBLIC (Respan-managed, organization NULL) workflows join list responses only when the caller opts in via is_including_public_workflows. Creating a public workflow requires a staff caller passing organization_id: null (the DEV-9422 global-create path).

get/api/workflows/

Query parameters

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

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