Sign in

4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB
workflows

Filter workflows

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.

post/api/workflows/list/

Query parameters

pageinteger
page_sizeinteger
sort_bystring

Sort field, for example -updated_at.

type'automations' | 'monitors' | 'evaluators' | 'reports' | 'exports' | 'ingests'

Workflow category. Defaults to automations.

trigger_event_type'request_log' | 'trace_completed' | 'customer_budget_limit_reached' | 'credit_low_balance_threshold_reached' | 'spend_cap_warning_threshold_reached' | 'limit_policy_soft_triggered' | 'limit_policy_hard_triggered' | 'on_eval_result_ingested' | 'custom_event' | 'eval_only' | 'scheduled'

Event that triggers the workflow. Use scheduled with schedule_cron.

searchstring

Free-text search over workflow names.

is_including_public_workflowsboolean

Include Respan-managed public workflows.

Headers

Authorizationstring required

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.

Request body

filtersobject

Filter parameters keyed by field name.

Response

Paginated filtered workflow families.

countinteger required
nextstring nullable required
previousstring nullable required
total_countinteger

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

current_filtersobject
filters_dataobject