Get Flow Action
GET {{baseUrl}}/api/flow-actions/:id/
Get a flow action from a flow with the given flow action ID.
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/v2024-07-15/reference/api-overview#sparse-fieldsets | |
fields[flow-message] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | |
fields[flow] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/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-action","id":"\u003cstring\u003e","attributes":{"action_type":"\u003cstring\u003e","status":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","settings":{},"tracking_options":{"add_utm":"\u003cboolean\u003e","utm_params":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"is_tracking_opens":"\u003cboolean\u003e","is_tracking_clicks":"\u003cboolean\u003e"},"send_options":{"use_smart_sending":"\u003cboolean\u003e","is_transactional":"\u003cboolean\u003e"},"render_options":{"shorten_links":"\u003cboolean\u003e","add_org_prefix":"\u003cboolean\u003e","add_info_link":"\u003cboolean\u003e","add_opt_out_language":"\u003cboolean\u003e"}},"links":{"self":"\u003curi\u003e"},"relationships":{"flow":{"data":{"type":"flow","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"flow-messages":{"data":[{"type":"flow-message","id":"\u003cstring\u003e"},{"type":"flow-message","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},"included":[{"type":"flow","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","trigger_type":"Metric"},"links":{"self":"\u003curi\u003e"}},{"type":"flow","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","trigger_type":"Date Based"},"links":{"self":"\u003curi\u003e"}}]}