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.
You can adjust the number of results per page via the page[size] query parameter, e.g. ?page[size]=25. Default: 20. Max: 100.
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/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>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/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":"profile","id":"aliquip sit veniam aliqua exercitation","attributes":{"email":"in adipisicing et","phone_number":"anim nostrud Duis","external_id":"magna commodo qui dolor","anonymous_id":"in cillum fugiat","first_name":"irure dolore dolor","last_name":"veniam aute commodo elit","organization":"non","title":"dolor Duis in ut","image":"veniam dolore","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","last_event_date":"2022-11-08T00:00:00","location":{"address1":"cillum dolore cupidatat sint aliquip","address2":"ex veniam esse","city":"dolor ad Duis aliquip","country":"fugiat officia eu consequat ex","latitude":"commodo","longitude":"dolore dolor ea","region":"voluptate","zip":"ut est laboris Excepteur","timezone":"esse dolor"},"properties":{}},"links":{"self":"https://ARJKGeoyTWUNpL.wbzkcyeoMyjZWl5,-TWaaKjr+,mFRXQXnE0812m..U,vLRnQewytvxTJnmIa5a"}},{"type":"profile","id":"dolore nisi fugiat aute in","attributes":{"email":"et Ut","phone_number":"sit anim nisi veniam proident","external_id":"dese","anonymous_id":"incididunt esse commodo dolore dolor","first_name":"non sunt fugiat mollit consequat","last_name":"sunt ullamco","organization":"tempor pariatur mollit","title":"in id proident veniam","image":"labore Duis","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","last_event_date":"2022-11-08T00:00:00","location":{"address1":"consequat esse et aliqua","address2":"a","city":"qui","country":"incididunt non consectetur anim","latitude":"exercitation in aute qui","longitude":"irure esse Duis","region":"tempor aliquip","zip":"adipisicing","timezone":"veniam qui"},"properties":{}},"links":{"self":"https://PvtEDAVdzdBdNmeyPWmsZBUS.sfMBh4gqK8SvE-sEunepHXObH-cxIGEYklt6NGBOsQHF2jhhuDb20HTp8DJdNxpd5"}}],"links":{"self":"https://yKByUeXQJRKiyvTCKtDxpEsbFrPtWGA.dhEwxvyGO4GjREmjHjFHo4.zucJ+8tGavHBeCsi,SiZhSP-OB0ErULj+z","first":"http://khPATMrgvscs.jvD4CjeKqNQadH-Q7I","last":"http://xbTwTuBpCHZRTZhUyjiBzDgmodDloRw.htpbfzgysTOMkrRBiknG0y.Xn16A4x5YmPLZTN1a","prev":"https://JLXgRAkSKrXm.yiZssnFbBDjNtR","next":"https://lfiXvVviXDgMATJUfnneTkf.zunkmtv,RojAKyf8Ow7mIJjgMLdTIPimR+HzSuk,QD18vaSOrGv-9sEP"}}