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, which can be paginated with cursor-based pagination.
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/v2022-10-17/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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/v2022-10-17/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","attributes":{"name":"proident nostrud eu ex mollit","created":"1968-09-29T16:25:22.926Z","updated":"1969-07-19T22:44:56.235Z"},"links":{"self":"https://LamrS.ibeobf7eG-L9XgKwWz+w.fJ"}},{"type":"list","id":"reprehenderit quis commodo","attributes":{"name":"minim in labore eiusmod","created":"1964-01-26T19:51:16.199Z","updated":"1989-02-02T23:33:54.091Z"},"links":{"self":"https://tujRuvvLjUNHNClPJCsxUuJOlGut.eapA+i2cz65Fw.LqHfJMJE8gXJYAR-vt4066eoLeEy6v9xQjVDGpVzZzWBwPD,hzkX6ZiDC"}}],"links":{"self":"http://gLagncsXWKxBkLCSkdGOKefqu.uddsNIGFiuLGaXdLGueBr,6n-BBNsrWWDr.NYjv2","first":"https://SWWacBWPemYdIPbFOMOxSgrY.aegBFVAFCDiqqVA5ccubMWsN7SzlZynP9cQbwKQQVHWyFsCEFAW2UntDz.p","last":"https://yekdBikosPdlOfqHYAhNA.cvwtTL-vNJK1aPT4R,8ZOpJ10wKK,9tqjDGgHc+PzQVc2HnUSC","prev":"http://jFdYJtqdHRscXV.lttjNq4ejHLcsS6I","next":"http://zvkiuniBpVpLAXWrMIGODWkiSia.bya6"}}