Get List Profiles
GET {{baseUrl}}/api/lists/:list_id/profiles/
Get all profiles within a list with the given list ID.
Filter to request a subset of all profiles. Profiles can be filtered by email, phone_number, and push_token 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
Profiles Read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[profile] | 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>email: any<br>phone_number: any<br>push_token: any<br>_kx: equals | |
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":"profile","id":"eu reprehender","attributes":{"email":"veniam","phone_number":"aliqua ea mollit","external_id":"in qui Lorem reprehenderit","anonymous_id":"in ea","first_name":"culpa laborum eu","last_name":"do","organization":"commodo deserunt ex in","title":"laboris voluptate officia","image":"laboris Ut sed amet","created":"1974-12-05T21:24:12.447Z","updated":"2006-09-05T19:46:47.650Z","last_event_date":"1998-07-10T22:17:11.779Z","location":{"address1":"enim ex nulla veniam","address2":"et","city":"officia","country":"sed conse","latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"region":"nostrud dolo","zip":"de","timezone":"adipisicing occaecat ullamco exercit"},"properties":{}},"links":{"self":"http://jfmuOaktoRTSUMyE.vcLEjpytMaWP1hbuY5ugfksLgPEQk,ocZf"}},{"type":"profile","id":"incididunt in","attributes":{"email":"elit velit Duis","phone_number":"reprehenderit nostrud consectetur tempor in","external_id":"eu quis nisi","anonymous_id":"cillum ullamco","first_name":"et incididunt Ut fugiat","last_name":"Ut consequat non","organization":"Excepteur","title":"irure","image":"minim dolor proident","created":"1990-08-04T11:32:23.315Z","updated":"1943-01-01T05:30:04.226Z","last_event_date":"2005-06-11T19:41:07.778Z","location":{"address1":"laboris","address2":"Excepteur","city":"consequat magna commodo","country":"do officia","latitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"longitude":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"region":"tempor anim minim","zip":"aliqua aliquip exercitation veniam","timezone":"enim"},"properties":{}},"links":{"self":"http://EUmusDWhoqVeHuyljFXeIBQtlTVoksXB.jgLJWmPxuAWZeMixOR+-qCoxRid+wIaqUOprpoBSMvEbUoOTnOfT3Hyy0F0zVxyAxR"}}],"links":{"self":"http://mFyAm.vxdlli0B0Jy3Wfk1tttq8LK+Ql-NE","first":"http://KnbkpxbgDtswd.upYOxhb0ag+6MWBzNChoGF5o+JCIGcpz7-NpK.EEa8RxMHTslLXeJS,S","last":"https://nyozeAIRstoXlAqVhUksTCjLd.iehbE0Dxkor9PPZ--CdQL+0O","prev":"http://xAGdOrODeBTdtWvLjLjsk.mvwGKb","next":"https://Evmdweu.elRXkxy,gTP0bJ8kRMm-lwD3y"}}