Skip to main content

Search Contacts

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

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​

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

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
    ContactsPage object
    totalRecords numberrequired
    totalPages numberrequired
    currentPage numberrequired
    records object[]required
  • Array [
    • contactId stringrequired
    pushName stringrequired
    remoteJid stringrequired
    pictureUrl stringrequired
    createdAt date-timerequired
  • ]
Loading...