Get List

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

Get a list with the given list ID.

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

Rate limits when using the additional-fields[list]=profile_count parameter in your API request:
Burst: 1/s
Steady: 15/m

To learn more about how the additional-fields parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.

Scopes:
list:read

Path Params

string

required

Defaults to Y6nRLr

Primary key that uniquely identifies this list. Generated by Klaviyo.

Query Params

additional-fields[list]

array of strings

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

additional-fields[list]

fields[list]

array of strings

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

fields[list]

fields[tag]

array of strings

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

fields[tag]

include

array of strings

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

include

Headers

revision

string

required

Defaults to 2023-09-15

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

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://a.klaviyo.com/api/lists/Y6nRLr/ \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/json' \
5
     --header 'revision: 2023-09-15'


xxxxxxxxxx
53
}
1
{
2
  "data": {
3
    "type": "list",
4
    "id": "Y6nRLr",
5
    "attributes": {
6
      "name": "Newsletter",
7
      "created": "2022-11-08T00:00:00",
8
      "updated": "2022-11-08T00:00:00",
9
      "profile_count": 0
10
    },
11
    "links": {
12
      "self": "string"
13
    },
14
    "relationships": {
15
      "profiles": {
16
        "data": [
17
          {
18
            "type": "profile",
19
            "id": "string"
20
          }
21
        ],
22
        "links": {
23
          "self": "string",
24
          "related": "string"
25
        }

200

4XX

5XX