Search Contacts

GET 
/api/v2/instance/:instanceId/chat/search/chats

Search Contacts

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Query Parameters

page Page

Default value: 1

(Optional) Page number in pagination.

sort Sort

Possible values: [desc, asc]

Default value: desc

(Optional) Sort the data in ascending or descending order.

Responses

200

The return will be a JSON containing up to 50 contacts that match the search criteria, paginated according to the page parameter.

application/json

Schema

Schema

instanceId stringrequired
name stringrequired
state stringrequired

Default value: active | inactive

connection stringrequired

Default value: open | close | refused

createdAt stringrequired
deletedAt date-timerequired
WhatsApp object
whatsappId stringrequired
remoteJid stringrequired
pictureUrl stringrequired
pushName stringrequired
createdAt stringrequired
Business object
businessId stringrequired
name stringrequired
ChatsPage object
totalRecords numberrequired
totalPages numberrequired
currentPage numberrequired
records object[]required
Array [
chatId stringrequired
remoteJid stringrequired
createdAt date-timerequired
]

Example (from schema)

{
  "instanceId": "string",
  "name": "string",
  "state": "active | inactive",
  "connection": "open | close | refused",
  "createdAt": "string",
  "deletedAt": "2024-04-14T14:11:05.708Z",
  "WhatsApp": {
    "whatsappId": "string",
    "remoteJid": "string",
    "pictureUrl": "string",
    "pushName": "string",
    "createdAt": "string"
  },
  "Business": {
    "businessId": "string",
    "name": "string"
  },
  "ChatsPage": {
    "totalRecords": 0,
    "totalPages": 0,
    "currentPage": 0,
    "records": [
      {
        "chatId": "string",
        "remoteJid": "string",
        "createdAt": "2024-04-14T14:11:05.709Z"
      }
    ]
  }
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...