---
title: "Get the all-contacts segment"
description: "The workspace's managed \"All subscribed contacts\" segment, made the first time it's asked for: the dashboard's \"Everyone subscribed\" campaign target. `POST /api/v1/segments/all-contacts`"
url: https://www.unitpost.com/docs/platform/post-segments-all-contacts
section: "Platform API reference"
updated: 2026-10-13
---
# Get the all-contacts segment

`POST /api/v1/segments/all-contacts`

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 fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | — |
| `id` | string | yes | — |
| `name` | string | yes | — |
| `description` | string \| null | yes | — |
| `type` | enum | yes | One of: `static`, `dynamic`. |
| `filter` | __schema0 \| null | yes | 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` | string | yes | — |
| `updated_at` | string | yes | — |

## Responses

| Status | Description |
| --- | --- |
| 200 | The segment (it existed). |
| 201 | The segment (made now). |
| 400 | The body isn't JSON. |
| 401 | Missing or invalid API key. |
| 403 | Insufficient scope. |
| 409 | `conflict`: a segment that doesn't target every contact already holds the name. |
| 422 | A body key (this operation takes none). |

## Example request

```bash
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'
```

## Example response (200)

```json
{
  "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"
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/platform/post-segments-all-contacts
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json