Get Flow Message

GET {{baseUrl}}/api/flow-messages/:id/

Get the flow message of a flow with the given message 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

KeyDatatypeRequiredDescription
fields[flow-action]stringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
fields[flow-message]stringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
includestringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships
includestringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#relationships

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{"data":{"type":"flow-message","id":"aute ut consequat","attributes":{"name":"exercitation sint","channel":"ullamco nulla","content":{"subject":"elit","preview_text":"mollit fugiat ut","from_email":"ut culpa","from_name":"non mollit laboris"},"created":"1963-05-31T04:52:11.042Z","updated":"1991-05-02T06:21:37.452Z"},"links":{"self":"https://UuMUkLldRxFPBpZCoZ.ekdkpLLJd+h0gzDV+rmAJZgdhiwAydb0TTls7R"},"relationships":{"flow-action":{"data":{"type":"flow-action","id":"mollit dolore commodo amet consequat"}}},"included":[{"type":"flow-action","id":"pariatur","attributes":{"action_type":"in esse dolor","status":"in","created":"1980-10-29T03:46:14.221Z","updated":"1992-06-04T21:30:30.808Z","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://lkCdphfJhINeQwiqFgTBnPQmelky.ynniMfOKpH-fRX3XmI"}},{"type":"flow-action","id":"occaecat esse","attributes":{"action_type":"non in irure","status":"labore sunt","created":"1985-12-25T22:58:19.978Z","updated":"1999-12-19T22:56:12.409Z","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://scIdcuFFiMenMARKP.zpxWQpSeGxDNQmmrek8QuFhX2epOZDOCh75kOx,aV6kmBRs"}}]}}