Filter workflows

POST

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

POST

/api/workflows/list/

$ curl -X POST https://api.respan.ai/api/workflows/list/ \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

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

List one representative version per workflow family using optional complex filters in the request body. An omitted body or omitted filters object applies only the query-string filters.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Query parameters

pageintegerOptional>=1

page_sizeintegerOptional>=1

sort_bystringOptional

Sort field, for example -updated_at.

typeenumOptionalDefaults to automations

Workflow category. Defaults to automations.

trigger_event_typeenumOptional

Event that triggers the workflow. Use scheduled with schedule_cron.

searchstringOptional

Free-text search over workflow names.

is_including_public_workflowsbooleanOptionalDefaults to false

Include Respan-managed public workflows.

Request

This endpoint expects an object.

filtersmap from strings to anyOptional

Filter parameters keyed by field name.

Response

Paginated filtered workflow families.

countinteger

nextstring or null

previousstring or null

resultslist of objects

total_countintegerOptional

Total count when available. This field can be omitted for API-key requests.

current_filtersmap from strings to anyOptional

filters_datamap from strings to anyOptional

Errors

400

Bad Request Error

401

Unauthorized Error