Skip to main content
POST
List Segment

Authorizations

Authorization
string
header
required

Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.

Headers

Content-Type
string

application/json

Body

application/json
limit
number
required

Maximum number of elements to return.

Maximum: 100 Minimum: 10

page
number
required

You can retrieve a subset of records starting from the page value you have specified. You can add a limit, which will determine the number of records you can retrieve on a single page.

Starts From: 1

Filter segment list by name , giving name as search keyword

Minimum string length: 1
sort_field
string
required

Sort segment list data based on the following field.

Available sort fields: name,active_count

Minimum string length: 1
sort_order
string
required

Sorting order for sort field

Available sort orders

asc, ASC, desc, DESC

Minimum string length: 1

Response

OK

count
number
required
data
object[]
required
Minimum array length: 1