Get Profiles
GET {{baseUrl}}/api/profiles/
Get all profiles in an account.
Profiles can be sorted by the following fields in ascending and descending order: id, created, email
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: 3/s
Steady: 60/m
Scopes:
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>id: any, equals<br>email: any, equals<br>phone_number: any, equals<br>external_id: any, equals<br>anonymous_id: any, equals<br>_kx: equals<br>created: greater-than, less-than | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sorting |
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":"enim velit dolore","attributes":{"email":"ullamco","phone_number":"in elit","external_id":"in magna","anonymous_id":"mollit ut proident veniam","first_name":"ea consequat aliqua Lorem","last_name":"et in ullamco ut","organization":"elit reprehenderit","title":"cillum eu","image":"elit amet id","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","last_event_date":"2022-11-08T00:00:00","location":{"address1":"proident dolor","address2":"non Duis adipisicing","city":"velit nisi","country":"laborum nulla","latitude":"labore aliquip in dolore pariatur","longitude":"reprehenderit cillum magna","region":"ven","zip":"aliquip magna","timezone":"laboris tempor"},"properties":{}},"links":{"self":"https://QPHDNBYRK.focfGs5QQCphZRZp6JhbUtYRpZ8hTElSXx5pKXulLKBq,P"},"relationships":{"lists":{"data":[{"type":"list","id":"dolore "},{"type":"list","id":"qui ex aliqua"}]},"segments":{"data":[{"type":"segment","id":"quis mollit irure occaecat"},{"type":"segment","id":"nostrud dolore mollit qui nisi"}]}}},{"type":"profile","id":"dolor culpa qui Lorem","attributes":{"email":"Lorem ex","phone_number":"Lorem tempor exercitation","external_id":"occaecat commodo ex","anonymous_id":"veniam consectetur esse magna","first_name":"tempor Ut","last_name":"consectetur ad commodo culpa","organization":"consequat qui","title":"nostrud deserunt reprehenderit sit","image":"minim et","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","last_event_date":"2022-11-08T00:00:00","location":{"address1":"est sit laborum ut","address2":"proident anim velit irure aliquip","city":"do id consequat fugiat","country":"consectetur ullamco dolore","latitude":"sit commodo fugiat eu","longitude":"nulla dolor cupidatat in","region":"ad sunt eiusmod sed","zip":"dolore minim incididunt quis","timezone":"commodo do consectetur dolor"},"properties":{}},"links":{"self":"https://xSD.anshg36zVePbWc.WS0qeBiBmFo0RNyXBauT5,GXhLeN"},"relationships":{"lists":{"data":[{"type":"list","id":"laboris labore"},{"type":"list","id":"eu fugiat"}]},"segments":{"data":[{"type":"segment","id":"cillum eu"},{"type":"segment","id":"amet laboris dolor"}]}}}],"links":{"self":"http://vleMFTbMjAHnZeLxFBaSmGZtw.upeu,ITmFtIJy+.FLzk,","first":"https://sLvHJqrgxSun.osYvk3tACvDmXgCs8adFKjIzsShYKxLjacv,KixxWsC49Jyk8","last":"http://hxmRmibviTPNyq.zkbYu5NQab1-ltW70MxkW","prev":"https://EJTDrCordQjKyNoYhVJMVAmgUuZvt.fjlLwaGUrMusZZvA.U,wfNeFSwN1DHxpGOcFjF8266XXbOUNL5qfV25E","next":"https://XAMESHgDWHRE.uaCDKSI8dWPRNMxpIR3uC"},"included":[{"type":"list","id":"dolore ut","attributes":{"name":"quis est nulla","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://pwNISmvueGxnaCVnxGLMDp.pzoptThh"}},{"type":"list","id":"ea in anim","attributes":{"name":"ut aute sed","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"http://BqnAUdqGtkiShqVSEzeDNieQEdgalqe.rnscVsaKH-9CRDwPF9kkgiJA"}}]}