{
"opencollection": "1.0.0",
"info": {
"name": "Klaviyo Accounts Profiles API",
"version": "2026-04-15"
},
"request": {
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"items": [
{
"info": {
"name": "Profiles",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Profiles",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "additional-fields[profile]",
"value": "",
"type": "query",
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
{
"name": "fields[profile]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "fields[push-token]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`, `equals`
`email`: `any`, `equals`
`phone_number`: `any`, `equals`
`external_id`: `any`, `equals`
`_kx`: `equals`
`created`: `greater-than`, `less-than`
`updated`: `greater-than`, `less-than`
`subscriptions.email.marketing.list_suppressions.reason`: `equals`
`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`subscriptions.email.marketing.list_suppressions.list_id`: `equals`
`subscriptions.email.marketing.suppression.reason`: `equals`
`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting"
}
]
},
"docs": "Get all profiles in an account.\n\nProfiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`
Rate limits when using the `additional-fields[profile]=p"
},
{
"info": {
"name": "Create Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/profiles",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "additional-fields[profile]",
"value": "",
"type": "query",
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new profile.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nThe maximum allowed payload size is 100KB.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:write`"
},
{
"info": {
"name": "Get Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "additional-fields[profile]",
"value": "",
"type": "query",
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
{
"name": "fields[list]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "fields[profile]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "fields[push-token]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "fields[segment]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships"
}
]
},
"docs": "Get the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`
Rate limits when using the `include=list` parameter in your API request:
Burst: `1/s`
Steady: `15/m`
Rate limits when using the `include=segment` parameter in your API request:
Burst: `1/s`
Steady: `15/m`
To learn more about how the `include` parameter i"
},
{
"info": {
"name": "Update Profile",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://a.klaviyo.com/api/profiles/:id",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo."
},
{
"name": "additional-fields[profile]",
"value": "",
"type": "query",
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:write`"
},
{
"info": {
"name": "Get Bulk Import Profiles Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-bulk-import-jobs",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "fields[profile-bulk-import-job]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `any`, `equals`"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting"
}
]
},
"docs": "Get all bulk profile import jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`"
},
{
"info": {
"name": "Bulk Import Profiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/profile-bulk-import-jobs",
"headers": [
{
"name": "revision",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a bulk profile import job to create or update a batch of profiles.\n\nAccepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB.\n\nTo learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`"
},
{
"info": {
"name": "Get Bulk Import Profiles Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-bulk-import-jobs/:job_id",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "job_id",
"value": "",
"type": "path",
"description": "ID of the job to retrieve."
},
{
"name": "fields[list]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "fields[profile-bulk-import-job]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships"
}
]
},
"docs": "Get a bulk profile import job with the given job ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`"
},
{
"info": {
"name": "Get Bulk Suppress Profiles Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-suppression-bulk-create-jobs",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "fields[profile-suppression-bulk-create-job]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`list_id`: `equals`
`segment_id`: `equals`"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting"
}
]
},
"docs": "Get the status of all bulk profile suppression jobs.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`"
},
{
"info": {
"name": "Bulk Suppress Profiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/profile-suppression-bulk-create-jobs",
"headers": [
{
"name": "revision",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list.\n\nSuppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`"
},
{
"info": {
"name": "Get Bulk Unsuppress Profiles Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-suppression-bulk-delete-jobs",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "fields[profile-suppression-bulk-delete-job]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`list_id`: `equals`
`segment_id`: `equals`"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting"
}
]
},
"docs": "Get all bulk unsuppress profiles jobs.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`"
},
{
"info": {
"name": "Bulk Unsuppress Profiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/profile-suppression-bulk-delete-jobs",
"headers": [
{
"name": "revision",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list.\n\nThis only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs"
},
{
"info": {
"name": "Get Bulk Unsuppress Profiles Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-suppression-bulk-delete-jobs/:job_id",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "job_id",
"value": "",
"type": "path",
"description": "ID of the job to retrieve."
},
{
"name": "fields[profile-suppression-bulk-delete-job]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
}
]
},
"docs": "Get the bulk unsuppress profiles job with the given job ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`"
},
{
"info": {
"name": "Get Push Tokens",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/push-tokens",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "fields[profile]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "fields[push-token]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `equals`
`profile.id`: `equals`
`enablement_status`: `equals`
`platform`: `equals`"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
}
]
},
"docs": "Return push tokens associated with company.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`"
},
{
"info": {
"name": "Create or Update Push Token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/push-tokens",
"headers": [
{
"name": "revision",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create or update a push token.\n\nThis endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices.\n\nThe maximum allowed payload size is 100KB.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`push-tokens:write`"
},
{
"info": {
"name": "Get Push Token",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/push-tokens/:id",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The value of the push token"
},
{
"name": "fields[profile]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "fields[push-token]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "include",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships"
}
]
},
"docs": "Return a specific push token based on its ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`"
},
{
"info": {
"name": "Delete Push Token",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://a.klaviyo.com/api/push-tokens/:id",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The value of the push token to delete"
}
]
},
"docs": "Delete a specific push token based on its ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`push-tokens:write`"
},
{
"info": {
"name": "Create or Update Profile",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/profile-import",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "additional-fields[profile]",
"value": "",
"type": "query",
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Given a set of profile attributes and optionally an ID, create or update a profile.\n\nReturns 201 if a new profile was created, 200 if an existing profile was updated.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.
*Rate limits*:
Burst: `75/s`
S"
},
{
"info": {
"name": "Merge Profiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/profile-merge",
"headers": [
{
"name": "revision",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Merge a given related profile into a profile with the given profile ID.\n\nThe profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile).\nThis endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile.\n\nTo learn more about how profile data is preserv"
},
{
"info": {
"name": "Bulk Subscribe Profiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/profile-subscription-bulk-create-jobs",
"headers": [
{
"name": "revision",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message.\nLearn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nIf a list is not provided, the opt-in process used will be determined by"
},
{
"info": {
"name": "Bulk Unsubscribe Profiles",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://a.klaviyo.com/api/profile-subscription-bulk-delete-jobs",
"headers": [
{
"name": "revision",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "> 🚧\n>\n> Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.\n\nUnsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nPush tokens provided in `subscriptions.push.tokens` will be removed for the specified profi"
},
{
"info": {
"name": "Get Push Tokens for Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id/push-tokens",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "fields[push-token]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
}
]
},
"docs": "Return all push tokens that belong to the given profile.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`"
},
{
"info": {
"name": "Get Push Token IDs for Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id/relationships/push-tokens",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Return the IDs of all push tokens associated with the given profile.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`"
},
{
"info": {
"name": "Get Lists for Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id/lists",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "fields[list]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
}
]
},
"docs": "Get list memberships for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`"
},
{
"info": {
"name": "Get List IDs for Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id/relationships/lists",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get list memberships for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`"
},
{
"info": {
"name": "Get Segments for Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id/segments",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "fields[segment]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
}
]
},
"docs": "Get segment memberships for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`"
},
{
"info": {
"name": "Get Segment IDs for Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id/relationships/segments",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get segment membership relationships for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`"
},
{
"info": {
"name": "Get Conversation for Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id/conversation",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get the conversation for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`"
},
{
"info": {
"name": "Get Conversation ID for Profile",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profiles/:id/relationships/conversation",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get the conversation relationship for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`"
},
{
"info": {
"name": "Get List for Bulk Import Profiles Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-bulk-import-jobs/:id/lists",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "fields[list]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
}
]
},
"docs": "Get list for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`"
},
{
"info": {
"name": "Get List IDs for Bulk Import Profiles Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-bulk-import-jobs/:id/relationships/lists",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
]
},
"docs": "Get list relationship for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`"
},
{
"info": {
"name": "Get Profiles for Bulk Import Profiles Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-bulk-import-jobs/:id/profiles",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "additional-fields[profile]",
"value": "",
"type": "query",
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
{
"name": "fields[profile]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
}
]
},
"docs": "Get profiles for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`"
},
{
"info": {
"name": "Get Profile IDs for Bulk Import Profiles Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-bulk-import-jobs/:id/relationships/profiles",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
}
]
},
"docs": "Get profile relationships for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`"
},
{
"info": {
"name": "Get Errors for Bulk Import Profiles Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/profile-bulk-import-jobs/:id/import-errors",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path"
},
{
"name": "fields[import-error]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
},
{
"name": "page[cursor]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "Default: 20. Min: 1. Max: 100."
}
]
},
"docs": "Get import errors for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`"
},
{
"info": {
"name": "Get Profile for Push Token",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/push-tokens/:id/profile",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The value of the push token"
},
{
"name": "additional-fields[profile]",
"value": "",
"type": "query",
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'"
},
{
"name": "fields[profile]",
"value": "",
"type": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets"
}
]
},
"docs": "Return the profile associated with the given push token.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`"
},
{
"info": {
"name": "Get Profile ID for Push Token",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://a.klaviyo.com/api/push-tokens/:id/relationships/profile",
"headers": [
{
"name": "revision",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The value of the push token"
}
]
},
"docs": "Return the ID of the profile associated with the given push token.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`"
}
]
}
],
"bundled": true
}