List Contacts

1.   / 
2. API   / 
3. Address Book   / 
4. List

---

Description

wss contact_list

The contact_list request returns a list of contacts.

Request Parameters

Name	Type	Description
updated_at	string	First name
limit	string	Nax number of contacts in the list

Note

You can also add the ids parameter if you need to get the target chat objects. The maximum number of ids in a request is 10.

Response Fields

Name	Type	Description
contacts	array[string]	List of user`s contacts

Example

Request

{
  "request": {
    "contact_list": {
      "updated_at": "2025-08-13T05:51:44.733Z",
      "limit": 56,
    },
    "id": "RequestId",
   },
};

Response

{
  "response": {
    "id": "RequestId",
    "contacts": [
      {
        "_id": "63480e68f4794709f802a2fa",
        "first_name": "Name",
        "last_name": "Surname",
        "company": "UserCompany",
        "email": [{ "type": "home", "value": "..." }],
        "phone": [
          { "type": "home", "value": "...", "matched_user_id": "uId7" }
        ],
        "updated_at": "2025-08-13T05:51:44.733Z",
        "created_at": "2025-08-13T05:51:44.733Z"
      },
      {
        "_id": "63480e68f4794709f802a2fy",
        "first_name": "Name2",
        "last_name": "Surname2",
        "company": "UserCompany2",
        "email": [{ "type": "home", "value": "..." }],
        "phone": [
          { "type": "home", "value": "...", "matched_user_id": "uId6" }
        ],
        "updated_at": "2025-08-13T05:51:44.733Z",
        "created_at": "2025-08-13T05:51:44.733Z"
      }
    ]
  }
}

See Also

SAMA chat server API: Address book Each of us has at least once faced a situation where we wanted to write to an friend from our contact list, but couldn’t find them on the platform. That is why...