GET /api/flow-actions/{id}/relationships/flow-messages

Get all relationships for flow messages associated with the given flow action ID.

Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.

Rate limits:
Burst: 3/s
Steady: 60/m

Scopes: flows:read

Servers

Path parameters

Name Type Required Description
id String Yes

Request headers

Name Type Required Description
revision String Yes

API endpoint revision (format: YYYY-MM-DD[.suffix])

Default value: "2025-04-15"

Query parameters

Name Type Required Description
filter String No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
name: contains, ends-with, equals, starts-with
created: equals, greater-or-equal, greater-than, less-or-equal, less-than
updated: equals, greater-or-equal, greater-than, less-or-equal, less-than

sort String No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting

Possible values:

  • "updated"
  • "created"
  • "id"
  • "name"
  • "-name"
  • "-id"
  • "-created"
  • "-updated"
pagesize Integer No

Default: 50. Min: 1. Max: 50.

Default value: 50

pagecursor String No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.