latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Flow

Retrieve a set of flows based by query

Used to query Flows

get/flows

Query parameters

workspace_idstring required

Restricts the query to flows associated with the given organization ID

flow_type'validate_page' | 'login' | 'verify_url' | 'mablscript' | 'check_links' | 'visual_page_validation' | 'api' | 'mobile'

Restricts the query to flows of a given type

reusableboolean

Restricts the query to reusable or non-reusable flows

has_snippetboolean

Restricts the query to flows that have or don't have snippets

snippetIdstring

Restricts the query to flows that use a given snippet

branchstring

The branch to retrieve flows from. Flows not on the branch will failover to their master versions, if they exist on master.

resolvable_on_branchboolean

If true, will only return flows that have a version that can be resolved on the specified branch

limitinteger

The limit to use for pagination

cursorstring

The cursor to use for pagination

Response

Array of flows matching the query

cursorstring

Cursor used for pagination