Skip to content

Flows API

List the ids of an action's messages

GEThttps://email.growthdept.ai/api/flow-actions/{id}/relationships/flow-messages

Sort by created, id, name, updated, ascending or descending (put - in front).

Rate limits

Burst: 3/s

Steady: 60/m

Tier S. See rate limits for how requests are counted.

Scopes

flows:read

Operation id

get_message_ids_for_flow_action The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

string

Filter expression.

Filtering guide

Fields and the operators each one takes:

  • 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

string

From links.next or links.prev of the previous page.

Pagination guide

integer1 to 50default 50

Default 50, at most 50.

Pagination guide

string

Default id.

Sorting guide

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataarray of objectsrequired

    data: 2 fields
    • typestringrequired

      flow-message
    • idstringrequired

  • linksobject

    links: 3 fields
    • selfstring (uri)required

    • prevstring (uri)

    • nextstring (uri)

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject