API Documentation
- API Overview
- Events
- Organization
- User
- Auth
- Organization Members
- Contacts
- Lists
- Campaigns
- Conversations
- GETGet conversations
- POSTPost conversations
- GETGet conversation
- POSTPost conversation
- DELDelete conversation
- POSTPost conversation assign
- POSTPost conversation unassign
- GETGet conversation messages
- POSTPost conversation messages
- POSTPost conversation upload
- POSTPost conversation read
- GETGet conversation generate summary
- GET
- Messages
- Integrations
- Analytics
- Knowledge Base
- System
Conversations
Get conversation
returns a single conversation
GET
/
conversation
/
{id}
Copy
curl --request GET \
--url https://api.wapikit.com/api/conversation/{id}
Copy
{
"conversation": {
"contact": {
"uniqueId": "<string>",
"name": "<string>",
"phone": "<string>",
"attributes": {},
"createdAt": "2023-11-07T05:31:56Z",
"status": "Active"
},
"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",
"numberOfUnreadMessages": 123,
"totalMessages": 123,
"status": "Active",
"assignedTo": {
"uniqueId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"accessLevel": "Owner",
"name": "<string>",
"email": "<string>",
"roles": [
{
"uniqueId": "<string>",
"name": "<string>",
"description": "<string>",
"permissions": [
"Get:OrganizationMember"
]
}
]
},
"tags": [
{
"label": "<string>",
"uniqueId": "<string>"
}
]
}
}
Path Parameters
The id value of the conversation you want to get.
Response
200
application/json
conversation object
The response is of type object
.
Was this page helpful?
Copy
curl --request GET \
--url https://api.wapikit.com/api/conversation/{id}
Copy
{
"conversation": {
"contact": {
"uniqueId": "<string>",
"name": "<string>",
"phone": "<string>",
"attributes": {},
"createdAt": "2023-11-07T05:31:56Z",
"status": "Active"
},
"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",
"numberOfUnreadMessages": 123,
"totalMessages": 123,
"status": "Active",
"assignedTo": {
"uniqueId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"accessLevel": "Owner",
"name": "<string>",
"email": "<string>",
"roles": [
{
"uniqueId": "<string>",
"name": "<string>",
"description": "<string>",
"permissions": [
"Get:OrganizationMember"
]
}
]
},
"tags": [
{
"label": "<string>",
"uniqueId": "<string>"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.