Skip to main content
POST
Search workflow versions

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of search_workflow_versions.

filter
object

Field filters, ANDed: {field: {eq | ne | in | nin | gte | lte | gt | lt | is_null}}; q inside it is free text. Omit for every row.

include
enum<string>[]

Relations to attach to every item; omit for the bare rows.

Available options:
workflow,
workflow_records_counts
sort
object

One column and its direction; omit for the default order.

page_size
integer

A version row carries the whole step tree, so a page is capped at 100 here (the platform default is 500).

Required range: 0 <= x <= 100
cursor
string | null

pagination.next_cursor of the previous page.

Response

search success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
search
items
object[]
required
pagination
object
required
applied_filters
object
required
includes
string[]
required
meta
object
required
counts
object