v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB

Segments

Get segment

Returns a segment by its unique identifier.

Scopes: segments.read

Rate Limiting: This endpoint is rate limited to 100 requests per minute.

get/segments/{segmentID}

Path parameters

segmentIDstring required

Segment ID (24 character hexadecimal)

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

Segment resource

archivedAtstring nullable

Segment archival timestamp, null if not archived (read-only)

createdAtstring

Segment creation timestamp (read-only)

isStarredboolean

Whether the segment is marked as a favourite

namestring

Segment name

segmentIDstring

Segment unique identifier (read-only)

status'ready' | 'building' | 'archived'

Segment processing status (read-only)

updatedAtstring

Segment last update timestamp (read-only)

Example response

{
  "archivedAt": "2026-06-01T00:00:00Z",
  "conditionGroups": [
    {
      "conditions": [
        {
          "entity": "contact",
          "junction": "and"
        }
      ]
    }
  ],
  "createdAt": "2026-01-15T10:30:00Z",
  "name": "VIP Customers",
  "segmentID": "000000000000000000000001",
  "status": "ready",
  "updatedAt": "2026-01-20T14:45:00Z"
}