Get Step Types

GET 
/workflows/step-types

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.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Sub-account (location) ID the workflow belongs to

types string

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.

kind string

Restrict results to actions or triggers

Available optionsactiontrigger

query string

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

limit number

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

Default value:20

skip number

Number of results to skip before the page starts

Default value:0

application/json

Successful response

application/json

Schema

Schema

locationIdstringrequired

Sub-account the catalog was scoped to

totalnumberrequired

Total matching step types before paging

countnumberrequired

Number returned in this response

skipnumberrequired

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

stepTypesobject[]required

The step types

notFoundobject[]required

types terms that matched no step type key

warningsobject[]required

Non-blocking findings

Example (auto)

{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "total": 1440,
  "count": 20,
  "skip": 0,
  "stepTypes": [
    {
      "kind": "action",
      "type": "add_contact_tag",
      "name": "Add Contact Tag",
      "provider": "native"
    }
  ],
  "notFound": [
    {
      "type": "made_up_type"
    }
  ],
  "warnings": [
    {
      "path": "actions[4]",
      "message": "Step has no incoming edges and may be unreachable."
    }
  ]
}