GET
/
clients
curl --request GET \
  --url https://api.chat-dash.com/v1/public/clients \
  --header 'Authorization: <authorization>'
[
  {
    "_id": "<string>",
    "name": "<string>",
    "loginId": "<string>",
    "email": "<string>",
    "language": "<string>",
    "type": "<string>"
  }
]

Headers

Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Response

200
application/json
OK
_id
string

The ID of the client

name
string

The client's name

loginId
string

The client's login ID (case-insensitive)

email
string

The client's email

language
string

The client's dashboard language setting (ISO 639-1)

type
string

The client's type (e.g. individual, member)