Flows

Get flow

Get a flow by name. All versions are returned unless latest=true.

get/flow/{name}

Request

  • Base URL
    https://api.lytics.io/v2
  • URL
    https://api.lytics.io/v2/flow/{name}
  • Auth
    API key in header Authorization

Path parameters

namestring required

The flow name

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

latestboolean

Return only the latest version of the flow

Response

Flow

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Example response

{
  "data": {
    "steps": [
      {
        "delay_until": {
          "time_of_day": "09:30",
          "timezone": "America/New_York"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.