Retrieve Segments

get

https://{APP_DOMAIN}/api/3.2/messages/segments

Returns a paginated list of email list segments — subscriber groups used for targeting message sends. Conditionally loads related models based on requested columns.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

integer

Filter by segment ID

name

string

Filter by segment name

publication_id

integer

Filter by publication ID

auto_responder_id

integer

Filter by auto responder ID

subscriber_id

integer

Filter segments containing this subscriber

references_segment_id

integer

Filter dynamic segments that reference this segment ID

advanced_segment_redirect_url

string

Filter by advanced segment redirect URL (partial match)

advanced_segment_is_suppression

boolean

Filter by suppression status

advanced_segment_suppression_type

string

Filter by suppression type (partial match)

id_with_name

string

Search by ID or name (partial match on both)

created_at

string

Filter by creation date. Supports operators: >, >=, <, <=

columns[]

integer

The field to be included in the json response. You can have multiple columns[] query params included in the request URL.

page

integer

The page to return.

per_page

integer

The total results to return per page.

sort

string

The field to sort the request by. column_name|asc OR desc

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200The retrieved segments