Skip to main content
GET
List customer lists
Each list has the fields described in Customer list fields. The list doesn’t include each list’s variants; use Get a customer list for those. Use meta.totalPages to know when you’ve fetched every page. page and limit must be positive whole numbers. Zero or a negative number returns 400 failed_update_data, and a value that isn’t a number causes a server error.

Authorizations

X-API-KEY
string
header
required

Query Parameters

page
integer
default:1

Page number, a positive whole number. Defaults to 1.

limit
integer
default:10

Customer lists per page, a positive whole number. Defaults to 10.

Matches lists whose name contains the text. Not case-sensitive.

Response

A page of customer lists.

message
string
Example:

"Customers fetched successfully"

meta
object
data
object[]