Skip to main content
GET
/
customer
Get Customer List
curl --request GET \
  --url https://chat.zoko.io/v2/customer \
  --header 'apikey: <api-key>'
{
  "currentPage": 123,
  "pageSize": 123,
  "totalPages": 123,
  "totalCustomers": 123,
  "customers": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "channel": "<string>",
      "channelId": "<string>",
      "lastIncomingMessageAt": 123,
      "contactable": true,
      "assignment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "team": true
      }
    }
  ]
}

Authorizations

​
apikey
string
header
required

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

Customer List

​
currentPage
integer

current page

​
pageSize
integer

page size

​
totalPages
integer

total number of pages available

​
totalCustomers
integer

total number of customers

​
customers
object[]