Get the flow step type schema

Returns the schema for flow step types, trigger events, and segment filters. Sourced from config/flows.yml.

GET /v1/my/flows/spec

Get the flow step type schema

cURL

curl --request GET \
  --url https://api.nitrosend.com/v1/my/flows/spec \
  --header 'Authorization: Bearer <token>'

200

{
  "filters": {},
  "triggers": [
    {
      "title": "<string>",
      "event": "<string>"
    }
  ],
  "steps": [
    {
      "type": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "params": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

API key (nskey_live_...) or JWT token. API key is checked first; if not found, falls back to Devise JWT authentication.

Response

200 - application/json

Flow specification

Schema for flow step types, trigger events, and segment filter names. Note: the raw response includes internal fields (icon, visible, inputs, outputs, alias) used by the flow editor UI — these can be ignored by API consumers.

filters · object

Show child attributes

triggers · object[]

Show child attributes

steps · object[]

Show child attributes