Get Lists
GET {{baseUrl}}/api/lists/
Get all lists in an account.
Filter to request a subset of all lists. Lists can be filtered by id, name, created, and updated fields.
Returns a maximum of 10 results per page.
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
List Read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[list] | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>name: any, equals<br>id: any, equals<br>created: greater-than<br>updated: greater-than | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination |
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":"elit sint magna consequat","attributes":{"name":"et commodo esse","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"http://GDUJwQpBFZPqJqRNfz.ykfiIPR,6fy,j3y4slAjYlIQ,iAt"}},{"type":"list","id":"ut proident adipisicing","attributes":{"name":"est eiusmod aute","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"http://gAbfsbbf.mpieiyS6Lt-lbeU-B4Y0Ws4lE3oNDXGHV7N+IPejV,L2ZzuAX9OE-9xvao3GkxFZ"}}],"links":{"self":"http://gnbe.kfTgKYb3v","first":"https://Mp.jqmgLUv2d2LWRN4IyIv59NTc1ZoWAefT,MR6,Ck","last":"https://NUcAKu.qouQESZckjeIL1J5qWop0xwRCiJ8fn12K+l2QEWv","prev":"https://wmiTuMUoVFLgYnBpKAWSNYmZnWLoyNX.vydlAb6YfDJ-5aonX2LEzUzn4HOCkrpiWLYLdCwF2qydORo","next":"http://rioWRnLnEjHvMcqErM.ycwxW"}}