GET
/
customer

Authorizations

apikey
string
headerrequired

Authentication is done via apikey provided for your account

Include the following in your request header

apikey: "your_apikey_here"

Query Parameters

page
string

page number ( for pagination)

pageSize
integer

page size (for pagination)

channel
enum<string>
required

customer channel

Available options:
whatsapp
includeAssign
boolean

include assignment details. Default is false

sortBy
enum<string>

sort by field

Available options:
name,
lastIncomingMessageAt,
contactable
orderBy
enum<string>

ascending or descending order

Available options:
asc,
desc

Response

200 - application/json
currentPage
integer

current page

pageSize
integer

page size

totalPages
integer

total number of pages available

totalCustomers
integer

total number of customers

customers
object[]