Segments

Segments are dynamic gorup of Contacts matching filtering rules. You can create, edit and delete segments on the dashboard.

The following API allows listing all existing segments. You can use the Segment ID to filter Contacts retrieved with the Contacts APIs.

List Segments

List the segments of an organization Role: Organization Manager Scope: organization_read, segments_read

GEThttps://explore.cloud4wi.com//v2/segments/organizations/{cid}

Path parameters

cid*string

id of the organization (aka tenant)

Response

200default

Array with the segments

Body

application/json

generatedstring

sizenumber

segmentsarray of segmentListResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://explore.cloud4wi.com//v2/segments/organizations/{cid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "generated": "text",
  "size": 0,
  "segments": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "lastRun": "text",
      "created": "text",
      "modified": "text",
      "segmentStatus": "text",
      "audience": 0
    }
  ]
}