Skip to main content
GET
Get segment by ID

Authorizations

X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

Path Parameters

identifier
string
required

Segment identifier, with or without the segment_ prefix

Pattern: ^(segment_)?[a-zA-Z0-9]{22}$

Response

✅ Segment retrieved successfully

id
string

Unique segment identifier with segment_ prefix

Pattern: ^segment_[a-zA-Z0-9]{22}$
Example:

"segment_Gh8Ij9Kl0Mn1Op2Qr3StUv"

name
string

Segment name

Example:

"Internal Testing"

created
string<date-time>

Segment creation timestamp

Example:

"2024-01-20T10:30:00Z"

updated
string<date-time>

Segment last update timestamp

Example:

"2024-01-20T10:30:00Z"