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
Use filters to narrow your results. Request specific fields using sparse fieldsets.
Returns a maximum of 20 profiles per page, which can be paginated with cursor-based pagination.
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
Profiles Write
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>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/v2022-10-17/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/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":"est non aliqua","attributes":{"email":"deserunt id et ullamco","phone_number":"in","external_id":"in exercitatio","anonymous_id":"sint laboris dolor nulla","first_name":"eu nostrud","last_name":"sint quis Ut culpa tempor","organization":"Excepteur su","title":"Excep","image":"aliqua amet elit proident cillum","created":"2003-06-16T23:46:17.908Z","updated":"1964-06-13T15:28:28.187Z","last_event_date":"1966-09-16T11:56:28.021Z","location":{"address1":"commodo Ut ad minim","address2":"pariatur laboris commodo occaecat","city":"minim ipsum","country":"sint Ut","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":"occaecat cupidatat reprehenderit","zip":"aute Lorem incididunt reprehenderit","timezone":"nisi veniam nulla"},"properties":{}},"links":{"self":"https://ozZVrEeVbsXNLFIsyW.zogqiU,AnVK8"},"relationships":{"lists":{"data":[{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},"segments":{"data":[{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}}},{"type":"profile","id":"anim nulla","attributes":{"email":"est in","phone_number":"Excepteur ad","external_id":"id labore deserunt consequat consectetur","anonymous_id":"incididunt dolor ut sit","first_name":"Ut pariatur","last_name":"voluptate","organization":"culpa","title":"dolor Ut laborum Excepteur","image":"voluptate quis","created":"1978-07-01T20:52:37.828Z","updated":"1956-09-18T00:57:37.396Z","last_event_date":"2006-12-27T01:43:48.332Z","location":{"address1":"commodo eu mollit officia","address2":"sunt eu Ut ex commodo","city":"culpa ut proident sed","country":"eiusmod ut eu","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":"sint Excepteur nisi","zip":"dolor deserunt consectetur proident","timezone":"Lorem"},"properties":{}},"links":{"self":"http://FYIdNsVuklKxgNtPSgqfGFyRMXUeuo.tebwsWbrsDiiEfTNy-A,EDUYo+6b4NZJu+Nh0c+ArL1J9,pKYIPSJBzXaLzAdsNj"},"relationships":{"lists":{"data":[{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]},"segments":{"data":[{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]}}}],"links":{"self":"http://yXLXpIXVsqoZUjsEcQpPSENdrxwN.abzmRqt","first":"https://SDOFc.felg-mzQPsgStu5sHZik.SFMKs","last":"https://izc.yhjYWOdNZXGbjCr9rUnWdcAGpJBtZWsXHJxGxT5p8I.6PQUShpy-23nCjEe","prev":"https://rNagKGksTJFbd.iabzelGgf+60kWPynDtVPYQKiwUaYBPWnxHbGBA06lqqAfTn18","next":"http://NnrhoJ.yoxbCPqJ22QuItzKai,UUBEwF4XM80zQ+MHdKVfcvQMzgsQM"}}