GET /api/segments

Get all segments in an account.

Filter to request a subset of all segments. Segments can be filtered by name, created, and updated fields.

Returns a maximum of 10 results per page.

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes: segments:read

Servers

Request headers

Name Type Required Description
revision String Yes

API endpoint revision (format: YYYY-MM-DD[.suffix])

Default value: "2025-04-15"

Query parameters

Name Type Required Description
fieldssegment[] Array No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets

fieldstag[] Array No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets

include[] Array No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#relationships

filter String No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
name: any, equals
id: any, equals
created: greater-than
updated: greater-than
is_active: any, equals
is_starred: equals

sort String No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting

Possible values:

  • "updated"
  • "created"
  • "id"
  • "name"
  • "-name"
  • "-id"
  • "-created"
  • "-updated"
fieldsflow[] Array No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets

pagecursor String No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.