Get Segments

get https://a.klaviyo.com/api/segments/

🚧
This endpoint is in beta and subject to change.
A beta revision header (2024-05-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 all segments in an account.

Filter to request a subset of all segments. Segments can be filtered by name, created, and updated fields.

Returns a maximum of 10 results per page.

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes:
segments:read

Query Params

fields[segment]

array of strings

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

fields[segment]

fields[tag]

array of strings

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

fields[tag]

filter

string

For more information please visit https://developers.klaviyo.com/en/v2024-05-15.pre/reference/api-overview#filtering
Allowed field(s)/operator(s):
name: any, equals
id: any, equals
created: greater-than
updated: greater-than
is_active: any, equals
is_starred: equals

include

array of strings

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

include

page[cursor]

string

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

Headers

revision

string

required

Defaults to 2024-05-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/segments/ \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/json' \
5
     --header 'revision: 2024-05-15.pre'


xxxxxxxxxx
179
}
1
{
2
  "data": [
3
    {
4
      "type": "segment",
5
      "id": "string",
6
      "attributes": {
7
        "name": "Repeat Purchasers",
8
        "definition": {
9
          "condition_groups": [
10
            {
11
              "conditions": [
12
                {
13
                  "type": "profile-group-membership",
14
                  "group_ids": [
15
                    "string"
16
                  ],
17
                  "timeframe_filter": {
18
                    "type": "date",
19
                    "operator": "after",
20
                    "date": "2022-11-08T00:00:00+00:00"
21
                  }
22
                },
23
                {
24
                  "type": "profile-group-membership",
25
                  "group_ids": [

200Success

4XXClient Error

5XXServer Error