Get a segment

GET/v1/segments/{id}

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

One segment: its type, its condition tree if dynamic, and its cached member count.

The count is from the last refresh rather than computed on read. For the actual contacts, use GET /v1/segments/{id}/members.

Path parameters

idstringrequired
Segment id.

Response

200 · Segment

segmentIdstringrequired
projectIdstring
namestringrequired
descriptionstring | null
typeenumrequired
Dynamic segments are computed from `conditions`; static segments are managed via the members endpoints.
dynamicstatic
conditionsobject | null
memberCountintegerrequired
createdAtdate-timerequired
updatedAtdate-timerequired

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

401Missing or invalid API key.
404Not found.
422Request validation failed (code `validation_error`, 422).

Request

curl https://api.volanea.com/v1/segments/id_123 \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "segmentId": "seg_4a71",
    "projectId": "<projectId>",
    "name": "Welcome",
    "description": "What this is for",
    "type": "dynamic",
    "conditions": {
      "logic": "and",
      "groups": [
        {
          "filters": null
        }
      ]
    },
    "memberCount": 1,
    "createdAt": "2026-01-01T09:00:00.000Z",
    "updatedAt": "2026-01-01T09:00:00.000Z"
  }
}

92 endpoints · OpenAPI document