Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-216381,9552.9 MB

f2cf3228f366

Automations

Search Automations

Search for automations matching the provided filters, including query text, template refs, app, and trigger types. Each Automation row is heavy (carries its full triggers and steps) — request a small page_size (≤10) to keep responses small.

post/api/v1/search/automations

Request body

appIdstring

Filter results to automations belonging to this application.

appIdsstring[] nullable

Filter results to automations belonging to any of the specified apps. Supersedes the singular app_id field when non-empty; when empty, the server falls back to app_id for backward compatibility.

direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'

Direction to sort in. Unspecified falls back to ASC when sort_field is set; when sort_field is also unspecified, the server default order (created_at DESC) applies.

isDraftboolean nullable

Tri-state draft filter. Unset = include both drafts and published; true = drafts only; false = published only.

pageSizeinteger

Maximum number of results to return per page.

pageTokenstring

Pagination token from a previous SearchAutomationsResponse.

querystring

Free-text search query to filter automations by name or description.

sortField'AUTOMATION_SORT_FIELD_UNSPECIFIED' | 'AUTOMATION_SORT_FIELD_DISPLAY_NAME' | 'AUTOMATION_SORT_FIELD_CREATED_AT' | 'AUTOMATION_SORT_FIELD_LAST_EXECUTED_AT' | 'AUTOMATION_SORT_FIELD_ENABLED' | 'AUTOMATION_SORT_FIELD_PRIMARY_TRIGGER_TYPE'

Column to sort by. Unspecified (0) means sort by created_at desc (server default).

statusesstring[] nullable

Filter results by automation status. Empty or containing both ON and OFF applies no status filter.

triggerTypesstring[] nullable

Filter results to automations with any of the specified trigger types.

Response

Successful response

nextPageTokenstring

Token to retrieve the next page of results, empty when no more results exist.