Get Flow
GET {{baseUrl}}/api/flows/:id/
Get a flow with the given flow ID.
Request specific fields using sparse fieldsets.
Include parameters can be provided to get the following related resource data: flow-actions
Rate limits:
Burst: 3/s
Steady: 60/m
Scopes:
Flows Read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[flow-action] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | |
fields[flow] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":{"type":"flow","id":"esse elit enim Excepteur quis","attributes":{"name":"aliquip","status":"Duis aute enim ad","archived":false,"created":"1981-06-03T07:22:54.601Z","updated":"1981-04-28T09:17:05.390Z","trigger_type":"cupidatat mollit Lorem adipisicing eiusmod"},"links":{"self":"http://NKHcaKoBTUFFwxOyvjIUywsafiWiB.lykDAmn,JvdPVQCIzd5jI-zM-a"},"relationships":{"flow-actions":{"data":[{"type":"flow-action","id":"mollit in ipsum"},{"type":"flow-action","id":"laboris consectetur deserunt"}]}},"included":[{"type":"flow-action","id":"incididunt mollit aliquip","attributes":{"action_type":"dolor pariatur ut","status":"amet in pariatur sint Duis","created":"1980-02-13T20:17:53.460Z","updated":"1979-01-07T15:38:21.974Z","settings":{},"tracking_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"send_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"render_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"links":{"self":"https://UZQVzdeaBSOrbyh.ppwsG6sxOhahaLTuAB4Ddrz,EgRgd8xM"}},{"type":"flow-action","id":"labo","attributes":{"action_type":"veniam cillum sunt Duis","status":"in dolore proident mollit ipsum","created":"2013-08-27T17:56:18.335Z","updated":"1988-04-19T03:25:11.842Z","settings":{},"tracking_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"send_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"render_options":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"links":{"self":"https://BMcfrvVmSAWjHTGDFQHdtYHQDp.zatkAMBm1Q2oAUTxDqkizw43Sqqq,.nxWiKn9FpbQXURvVg1WRu7v-"}}]}}