Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

customer_type
enum<string>

Filter by customer type

Available options:
lead,
free,
paid
query
string

Search by email or name

starting_after
string

Cursor for pagination — the ID of the last item in the previous page

limit
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

List of customers

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string
required