List all segments

GET/cdp/{connection_id}/segment

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

idstring
Unique identifier for this segment object
created_atdate
The date that this segment object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
The last date that this segment object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The name of the segment/audience
slugstring
The data-plane handle/key used to identify segment membership in profiles and destinations
descriptionstring
The description of the segment/audience
definitionstring
The membership rule/query that defines the segment
type enum
Valid values:
"USERS"
"ACCOUNTS"
"LINKED"
The type of entity the segment targets (USERS, ACCOUNTS, LINKED)
compute_mode enum
Valid values:
"REALTIME"
"BATCH"
How the segment membership is computed (REALTIME or BATCH)
sizenumber
The number of profiles currently in the segment
is_activeboolean
Whether the segment is active/enabled
source_idstring
The cdp_source this segment originated from; points to CdpSource
const options = {
  method: 'GET',
  url: 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/segment',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-07-23T00:46:18.671Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?