GET
/
conversations
curl --request GET \
  --url https://api.wapikit.com/api/conversations
{
  "conversations": [
    {
      "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>"
        }
      ]
    }
  ],
  "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

​
order
enum<string>

order by asc or desc

Available options:
asc,
desc
​
status
enum<string>

sort by a field

Available options:
Active,
Closed,
Deleted
​
contact_id
string

query conversations with a contact id.

​
campaign_id
string

query conversations with a campaign id.

​
list_id
string

query conversations with a list id.

​
message_id
string

query conversations with a message id.

Response

200
application/json

list of conversations

The response is of type object.

GET
/
conversations
curl --request GET \
  --url https://api.wapikit.com/api/conversations
{
  "conversations": [
    {
      "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>"
        }
      ]
    }
  ],
  "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

​
order
enum<string>

order by asc or desc

Available options:
asc,
desc
​
status
enum<string>

sort by a field

Available options:
Active,
Closed,
Deleted
​
contact_id
string

query conversations with a contact id.

​
campaign_id
string

query conversations with a campaign id.

​
list_id
string

query conversations with a list id.

​
message_id
string

query conversations with a message id.

Response

200
application/json

list of conversations

The response is of type object.