returns all contacts.
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
}
}
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
The response is of type object
.
Was this page helpful?
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
}
}
returns all contacts.
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
}
}
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
The response is of type object
.
Was this page helpful?
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
}
}