Get Flow

get https://a.klaviyo.com/api/flows/{id}

🚧
This endpoint is in beta and subject to change.
A beta revision header (2024-10-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Get a flow with the given flow ID.

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

Scopes:
flows:read

Path Params

string

required

Query Params

additional-fields[flow]

array of strings

Request additional fields not included by default in the response. Supported values: 'definition'

additional-fields[flow]

fields[flow-action]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2024-10-15.pre/reference/api-overview#sparse-fieldsets

fields[flow-action]

fields[flow]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2024-10-15.pre/reference/api-overview#sparse-fieldsets

fields[flow]

fields[tag]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2024-10-15.pre/reference/api-overview#sparse-fieldsets

fields[tag]

include

array of strings

For more information please visit https://developers.klaviyo.com/en/v2024-10-15.pre/reference/api-overview#relationships

include

Headers

revision

string

required

Defaults to 2024-10-15.pre

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

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://a.klaviyo.com/api/flows/id \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/vnd.api+json' \
5
     --header 'revision: 2024-10-15.pre'


xxxxxxxxxx
1221
}
1
{
2
  "data": {
3
    "type": "flow",
4
    "id": "string",
5
    "attributes": {
6
      "name": "string",
7
      "status": "string",
8
      "archived": true,
9
      "created": "2022-11-08T00:00:00+00:00",
10
      "updated": "2022-11-08T00:00:00+00:00",
11
      "trigger_type": "Added to List",
12
      "definition": {
13
        "triggers": [
14
          {
15
            "type": "list",
16
            "id": "string"
17
          },
18
          {
19
            "type": "segment",
20
            "id": "string"
21
          },
22
          {
23
            "type": "metric",
24
            "id": "string",
25
            "trigger_filter": {

200Success

4XXClient Error

5XXServer Error