Retrive a list of clients

Retrieve a list of clients

get

Returns a paginated list of clients, with a maximum of 100 records per page.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

businessnamestringRequired

Name of the business

Query parameters

ds_phonestringOptional

Filter clients by phone number

_idstringOptional

Filter clients by client ID

limitinteger · max: 100Optional

Number of records to return

skipintegerOptional

Number of records to skip

Responses

200

A list of clients

application/json

get

/clients

HTTPcURLJavaScriptPython

GET /ext/v2/{businessname}/clients HTTP/1.1
Host: api.pingueen.it/ext/v2/{businessname}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A list of clients

[
  {
    "_id": "text",
    "ds_name": "text",
    "ds_surname": "text",
    "ds_phone": "text",
    "email": "text",
    "is_enabled": true,
    "user": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "dt_last_message": "2025-12-03T04:33:28.118Z",
    "last_message": "text"
  }
]