Api Workflows List

GET

https://api.respan.ai/api/workflows/

GET

/api/workflows/

$ curl https://api.respan.ai/api/workflows/ \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "count": 25,
3   "results": [
4     {
5       "is_enabled": true,
6       "is_public": true,
7       "unique_organization_id": "string",
8       "created_at": "2024-01-15T09:30:00Z",
9       "updated_at": "2024-01-15T09:30:00Z",
10       "editor": {
11         "id": 1,
12         "email": "string",
13         "name": "string",
14         "username": "string",
15         "first_name": "string",
16         "last_name": "string"
17       },
18       "tags": [
19         {
20           "id": "string",
21           "name": "string",
22           "color": "string",
23           "created_at": "2024-01-15T09:30:00Z",
24           "updated_at": "2024-01-15T09:30:00Z"
25         }
26       ],
27       "deployed_version": 1,
28       "id": "string",
29       "workflow_id": "string",
30       "version": 1,
31       "name": "string",
32       "description": "string",
33       "type": "automations",
34       "trigger_event_type": "request_log",
35       "is_starred": true,
36       "is_read_only": true,
37       "has_async_steps": true
38     }
39   ],
40   "next": "string",
41   "previous": "string",
42   "total_count": 100,
43   "current_filters": {},
44   "filters_data": {}
45 }

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).

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).

Authentication

AuthorizationBearer

JWT access token or Respan API key

Query parameters

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Response

countinteger

resultslist of objects

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

total_countinteger

current_filtersobject

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_dataobject