Skip to main content
POST
Get segment definitions
Required scopes: customers:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json

The body is of type object.

Response

List of segment definitions in the organization.

segment_definitions
object[]
required

The active definitions for the organization, ordered by segment_id. Every organization starts with the lead definition at ID 0. The qualified lead definition at ID 1 appears only after the organization creates it. Deleted definitions are absent, so the array can be empty. Restoring a deleted lead or qualified lead definition reuses its fixed ID but may apply different conditions.