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

_idstringOptional

ds_namestringOptional

ds_surnamestringOptional

ds_phonestringOptional

emailstringOptional

is_enabledbooleanOptional

userstringOptional

dt_last_messagestring · date-timeOptional

last_messagestringOptional

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": "2026-02-27T20:26:21.451Z",
    "last_message": "text"
  }
]

Opt-in

Opt-in information are available inside Client objetct. To update cd_status read the docs here.

Status	Description
0	Not requested
100	Requested
200	Accepted
500	Rejected

Full client exemple

  [
    {
        "_id": "697....fa1",
        "ds_phone": "39.....51",
        "user": "624......d25",
        "createdAt": "2026-01-26T09:47:44.127Z",
        "ds_address": "",
        "ds_name": "Name",
        "ds_surname": "",
        "dt_last_message": "2026-01-27T12:48:52.487Z",
        "email": "",
        "is_enabled": true,
        "is_suspended": false,
        "manual_assignees": [
            {
                "agent": "624fd.....c21d25",
                "dt_until": "2146-01-26T10:45:27.000Z"
            }
        ],
        "meta_info": [],
        "metadata": {},
        "opt_in": {
            "cd_status": 0
        },
        "read_later": false,
        "last_message": "6978....069c"
    }
]