GET
/
contacts
cURL
curl --request GET \
  --url https://api.wapikit.com/api/contacts
{
  "contacts": [
    {
      "uniqueId": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "attributes": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "lists": [
        {
          "name": "<string>",
          "description": "<string>",
          "numberOfContacts": 123,
          "numberOfCampaignsSent": 123,
          "tags": [
            {
              "label": "<string>",
              "uniqueId": "<string>"
            }
          ],
          "uniqueId": "<string>",
          "createdAt": "2023-11-07T05:31:56Z"
        }
      ],
      "tags": [
        {
          "label": "<string>",
          "uniqueId": "<string>"
        }
      ],
      "conversations": [
        {
          "uniqueId": "<string>",
          "contactId": "<string>",
          "campaignId": "<string>",
          "organizationId": "<string>",
          "initiatedBy": "Contact",
          "messages": [
            {
              "uniqueId": "<string>",
              "conversationId": "<string>",
              "direction": "InBound",
              "status": "Read",
              "messageType": "Text",
              "createdAt": "2023-11-07T05:31:56Z",
              "replyToMessageId": "<string>",
              "whatsAppMessageId": "<string>",
              "messageData": {
                "text": "<string>"
              }
            }
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "status": "Active"
        }
      ],
      "status": "Active"
    }
  ],
  "paginationMeta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Query Parameters

​
page
integer
required

number of records to skip

​
per_page
integer
required

max number of records to return per page

​
list_id
string

query subscribers with a list id.

​
order
enum<string>

order by asc or desc

Available options:
asc,
desc
​
status
string

sort by a field

​
searchString
string

search

Response

contacts list

The response is of type object.