Skip to main content
GET
Get all segments

Authorizations

X-Team-ApiKey
string
header
required

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

Example:

Query Parameters

offset
integer
default:0

Number of segments to skip

Required range: x >= 0
limit
integer
default:30

Maximum number of segments to return

Required range: x >= 1

Only return segments whose name contains this text (case-insensitive)

entity
enum<string>
default:id

Field to sort by

Available options:
id,
name,
created,
updated
order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc

Response

✅ Segments 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"