List segments

GET/v1/segments

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

Every segment in the project — dynamic and static — with its conditions and cached memberCount.

Unpaginated. The count is as of the last refresh, not live: a dynamic segment whose contacts changed since then reports a stale number until POST /v1/segments/{id}/refresh recomputes it.

Response

All segments.

dataobject[]required
- 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.

Request

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

Response

200 · application/json

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

92 endpoints · OpenAPI document