Get List
GET {{baseUrl}}/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
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
additional-fields[list] | string | Request additional fields not included by default in the response. Supported values: 'profile_count' | |
additional-fields[list] | string | Request additional fields not included by default in the response. Supported values: 'profile_count' | |
fields[list] | string | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | |
fields[tag] | string | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#relationships |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":{"type":"list","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e","profile_count":"\u003cinteger\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profiles":{"data":[{"type":"profile","id":"\u003cstring\u003e"},{"type":"profile","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},"included":[{"type":"tag","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"}},{"type":"tag","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"}}]}