1. Conversations API
Hatif
  • Account API
    • Service Login
      POST
  • Channels API
    • Get Channels
      GET
  • Whatsapp API
    • Send Text
      POST
    • Send Template
      POST
  • Contact
    • Set Property Value on Contact
      PUT
    • Search Contacts [Complex]
      POST
    • Delete Property Value on Contact
      DELETE
    • Create Contact
      POST
    • Update Contact
      PUT
    • Get Contacts
      GET
    • Get Contact By Id
      GET
    • Delete Contact
      DELETE
    • Create Bulk Contacts vCards
      POST
    • Create Contact
      POST
    • Get Contacts Search
      POST
    • Contacts History
      GET
  • Contact Properties
    • List Contact Properties
      GET
    • Delete Contact Property
      DELETE
    • Update Contact Property
      PUT
    • Create Contact Property
      POST
    • Contact Properties Statistics
      GET
  • Support API
    • Upload Audio File
  • Outbound IVR API
    • Create Outbound IVR
  • Workspace API
    • Get Workspace Users
  • Conversations API
    • Get Conversation Timeline
      GET
    • List Conversations
      GET
    • Create Conversation
      POST
    • Assign Conversation
      POST
    • Get Conversation
      GET
  • Tags API
    • Create Tag
    • Delete Tag
    • Update Tag
    • List Tags
  • Call Webhook
  • WhatsApp Message Webhook
  • Schemas
    • Call Webhook
    • WhatsApp Message Webhook
    • ConversationDto
    • CreateTagDto
    • ChannelConversationDto
    • UpdateTagDto
    • TagDto
    • ConversationTimelineDto
    • PagedResultOfTagDto
    • AiSummaryDto
    • ReplyInfoDto
    • InternalThreadDto
    • LocationMessageDto
    • AssignationInfoDto
    • PagedResultOfConversationDto
    • PagedResultOfConversationTimelineDto
  1. Conversations API

List Conversations

GET
/v2/conversations/service-account/channels/{channelId}
Returns a paged list of conversations for a channel.

Request

Authorization
OAuth 2.0
Client Credentials
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Token URL: https://your-auth-server/connect/token
Scopes:
VoxaAPI-Access Voxa API as a service account
or
Path Params

Query Params

Responses

🟢200
application/json
Paged list of conversations
Bodyapplication/json

🟠401
🟠403
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.voxa.sa/v2/conversations/service-account/channels/?Status=undefined&AssigneeUserIds=undefined&GetUnAssigned=undefined&ContactIds=undefined&TagIds=undefined&Name=undefined&PhoneNumber=undefined&FromDate=undefined&ToDate=undefined&IsLost=undefined&Sorting=undefined&SkipCount=undefined&MaxResultCount=undefined'
Response Response Example
{
    "TotalCount": 1,
    "Items": [
        {
            "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "Sentiment": null,
            "Status": 1,
            "LastActivityAt": "2026-03-17T12:00:00Z",
            "ContactId": "8a2e0b4c-1234-5678-9abc-def012345678",
            "ContactName": "John Doe",
            "ContactType": 1,
            "PhoneNumber": "+966500111222",
            "ChannelId": "b1c2d3e4-5678-9abc-def0-123456789abc",
            "AssigneeId": null,
            "AssignedAiAgentId": null,
            "IsAiAssignee": false,
            "AssigneeName": null,
            "Channel": {
                "Id": "b1c2d3e4-5678-9abc-def0-123456789abc",
                "Name": "Main Line",
                "Type": 1,
                "Icon": null,
                "PhoneNumber": "+966500000001"
            },
            "LastEventSourceType": 1,
            "LastEventDirection": 1,
            "LastEventStatus": "Answered",
            "LastEventPreviewBody": null,
            "LastEventOccurredAt": "2026-03-17T12:00:00Z",
            "LastEventsCount": 3,
            "Tags": [],
            "UnreadCount": 0
        }
    ]
}
Modified at 2026-03-18 00:05:38
Previous
Get Conversation Timeline
Next
Create Conversation
Built with