Get the all-contacts segment

POST/api/v1/segments/all-contacts

POST /segments/all-contacts

curl -X POST 'https://www.unitpost.com/api/v1/segments/all-contacts' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "segment",
  "id": "id_123",
  "name": "Example",
  "description": "string",
  "type": "static",
  "filter": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

The workspace's managed "All subscribed contacts" segment, made the first time it's asked for: the dashboard's "Everyone subscribed" campaign target. Repeating the call returns the same segment. Takes no body. Requires the segments:write capability.

Response · 200 fields8 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`description`required	string \| null	—
`type`required	enumstatic \| dynamic	—
`filter`required	__schema0 \| null	Dynamic segments only: the saved filter, evaluated live. A condition on a custom field uses the field's default_value for any contact with no value (key missing or null), the same value merge tags use; defaults are never written onto contacts. is_set / is_not_set check whether the contact itself has a value.
`created_at`required	string	—
`updated_at`required	string	—

200201400401403409422

Get the all-contacts segment

Get the all-contacts segment

Search docs and guides