Skip to main content
POST

Authorizations

​
Authorization
string
header
required

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

Headers

​
Content-Type
string
default:application/json
required

Request body type

Body

application/json
​
limit
number
required

Maximum number of elements to return.

Maximum: 100 Minimum: 10

Required range: 10 <= x <= 100
​
list_type
number
required

Your List type .

Available Choices

Normal List: 1

​
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

Required range: x <= 3
​
search_name
string

Filter list by name , giving name in search keyword

Minimum string length: 1
​
sort_field
string

Sort list data based on this field

Available sort fields

name,contact_count,open_percentage

Minimum string length: 1
​
sort_order
string

Sorting order for sort field

Available sort orders

asc, ASC, desc, DESC

Minimum string length: 1

Response

OK

​
count
number
​
data
object