Segments

Get a segment

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.

get/v1/segments/{id}

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/segments/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Segment id.

Response

The segment.

segmentIdstring required
projectIdstring
namestring required
descriptionstring nullable
type'dynamic' | 'static' required

Dynamic segments are computed from conditions; static segments are managed via the members endpoints.

memberCountinteger required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.