Get Flow

GET {{baseUrl}}/api/flows/:id/

Get a flow with the given flow ID. 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

HEADERS

RESPONSES

status: OK

{"data":{"type":"flow","id":"aute pariatur veniam","attributes":{"name":"qui","status":"in ut","archived":true,"created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","trigger_type":"irure mollit"},"links":{"self":"http://eCFoMrPoxPQkBydnacrcHXOwPBQsLsK.hoV9T7nMnkhR6lgjkzb4AGH8t26n2a2iVDo3ZoRqK9LeYQJl-OR1F,oaoQUZ3Tq.aJ8bBLjcxq"},"relationships":{"flow-actions":{"data":[{"type":"flow-action","id":"laboris ut fugiat Duis"},{"type":"flow-action","id":"ut"}]}}},"included":[{"type":"flow-action","id":"commodo Excepteur id aliqua","attributes":{"action_type":"dolor est","status":"non","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","settings":{},"tracking_options":{"add_utm":false,"utm_params":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"is_tracking_opens":false,"is_tracking_clicks":true},"send_options":{"use_smart_sending":true,"is_transactional":true},"render_options":{"shorten_links":false,"add_org_prefix":true,"add_info_link":true,"add_opt_out_language":true}},"links":{"self":"https://RNCEelBuvfXPLoimOqJXoviapXw.tqEiOK4kvOdnBY8i9Ctf7lyOOMRZh+0o54jtLvQjqRo+IctWov,bgaSymX9IJfM5G7mIBCITWn"}},{"type":"flow-action","id":"cupidatat pariatur sed amet","attributes":{"action_type":"tempor","status":"officia nostrud","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","settings":{},"tracking_options":{"add_utm":true,"utm_params":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"is_tracking_opens":true,"is_tracking_clicks":false},"send_options":{"use_smart_sending":false,"is_transactional":true},"render_options":{"shorten_links":true,"add_org_prefix":true,"add_info_link":false,"add_opt_out_language":true}},"links":{"self":"http://xVpFfKpjnfqJHlPgbohiz.acfdUJAr46pzzFPADY1Lw5DUSJmPKomKktt7X73m,b-P9RCVAVdj"}}]}