Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

An API credential from Settings → API, sent as Authorization: Bearer mdsk_api_.... Issued per workspace and shown once.

Query Parameters

cursor
string<base64url>

The next_cursor from the previous page. Omit for the first page.

Maximum string length: 512
Pattern: ^[A-Za-z0-9_-]*$
limit
integer
default:25

How many customers to return. 1 to 100, default 25.

Required range: 1 <= x <= 100
email
string<email>

Only the customer with this address, ignoring case.

Maximum string length: 254
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
q
string

Matches a name or an email address.

Required string length: 1 - 200

Response

A page of customers.

data
object[]
required
next_cursor
string | null
required