API Documentation
- API Overview
- Events
- Organization
- User
- Auth
- Organization Members
- Contacts
- Lists
- Campaigns
- Conversations
- Messages
- Integrations
- Analytics
- Knowledge Base
- System
Contacts
Get contacts 1
handles the retrieval of a single contact by id.
GET
/
contacts
/
{id}
Copy
curl --request GET \
--url https://api.wapikit.com/api/contacts/{id}
Copy
{
"contact": {
"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"
}
}
Path Parameters
The id value of the contact you want to get.
Response
200
application/json
gets a single contact.
The response is of type object
.
Was this page helpful?
Copy
curl --request GET \
--url https://api.wapikit.com/api/contacts/{id}
Copy
{
"contact": {
"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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.