Skip to main content
WorkflowsVersion: v3

Get Step Types

GET/workflows/step-types

Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Browse or fetch the action and trigger schemas available to a sub-account, so a definition can be built against real field names before saving.

Every response is paged and every entry carries its full field schema, including the assetReferences that say which fields must hold IDs of assets that already exist. Default page size is 20.

Narrow with types, which matches on the step type key and matches partially — email returns send_email as well as email. Use query instead to match names and descriptions too. Page with limit and skip.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:workflows.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version. Send v3.

Available optionsv3
Example:v3

Query Parameters

locationIdstringrequired

Sub-account (location) ID the workflow belongs to

Example:ve9EPM428h8vShlRW1KT
typesstring

Comma-separated step type filters (max 50 terms). Each term matches any step type whose key contains it, so email returns send_email as well as email, and an exact key still matches itself. Matching looks only at the type key — not the name or description — so a step merely described as emailing something will not appear.

A term matching nothing is reported in notFound. Results are paged like any other request.

Example:email,add_contact_tag
kindstring

Restrict results to actions or triggers

Available optionsactiontrigger
Example:action
querystring

Free-text match over type, name and description — broader than types, which matches the type key only. Ignored when types is supplied.

Example:tag
limitnumber

Page size. Kept small by default because every entry carries its full field schema.

Default:20
Example:20
skipnumber

Number of results to skip before the page starts

Default:0
Example:0

Response

Successful response

locationIdstringrequired

Sub-account the catalog was scoped to

Example:ve9EPM428h8vShlRW1KT
totalnumberrequired

Total matching step types before paging

Example:1440
countnumberrequired

Number returned in this response

Example:20
skipnumberrequired

The skip this page started at — echoed back so a caller paging through can tell which slice it received without tracking the request.

Example:0
stepTypesobject[]required

The step types

notFoundobject[]required

types terms that matched no step type key

warningsobject[]required

Non-blocking findings