curl --request GET \
--url https://api.wapikit.com/api/contacts \
--header 'x-access-token: <api-key>'{
"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>"
}
],
"status": "Active",
"conversations": [
{
"uniqueId": "<string>",
"contactId": "<string>",
"organizationId": "<string>",
"initiatedBy": "Contact",
"messages": [
{
"uniqueId": "<string>",
"conversationId": "<string>",
"direction": "InBound",
"status": "Read",
"messageType": "Text",
"createdAt": "2023-11-07T05:31:56Z",
"whatsAppMessageId": "<string>",
"messageData": {
"text": "<string>"
},
"replyToMessageId": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"status": "Active",
"campaignId": "<string>"
}
]
}
],
"paginationMeta": {
"page": 123,
"per_page": 123,
"total": 123
}
}returns all contacts.
curl --request GET \
--url https://api.wapikit.com/api/contacts \
--header 'x-access-token: <api-key>'{
"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>"
}
],
"status": "Active",
"conversations": [
{
"uniqueId": "<string>",
"contactId": "<string>",
"organizationId": "<string>",
"initiatedBy": "Contact",
"messages": [
{
"uniqueId": "<string>",
"conversationId": "<string>",
"direction": "InBound",
"status": "Read",
"messageType": "Text",
"createdAt": "2023-11-07T05:31:56Z",
"whatsAppMessageId": "<string>",
"messageData": {
"text": "<string>"
},
"replyToMessageId": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"status": "Active",
"campaignId": "<string>"
}
]
}
],
"paginationMeta": {
"page": 123,
"per_page": 123,
"total": 123
}
}number of records to skip
max number of records to return per page
query subscribers with a list id.
order by asc or desc
asc, desc sort by a field
search
contacts list
Show child attributes
Show child attributes
Active, Inactive, Blocked Show child attributes
Contact, Campaign, OrganizationMember The message object returned from the API (or retrieved from the database) with a discriminator to determine the concrete type.
Show child attributes
Unique identifier of the message.
ID of the conversation.
Direction of the message – whether it was received (inbound) or sent (outbound).
InBound, OutBound Message status.
Read, Unread, Sent, Delivered, UnDelivered, Failed, Received Discriminator field used to determine the concrete message type.
Text Time when the message was created.
ID of the message in WhatsApp.
ID of the message to which this message is a reply.
Active, Closed, Deleted Was this page helpful?