Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. SMS
  • Platform
    • Users
      • List Users
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
      • Create User
    • Groups
      • List Child Groups
      • Get Group Tree
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • List Webhooks
      • Get Webhook Details
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
      • Create Webhook
    • Media Prompts
      • List Prompts
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Create Agent
      POST
    • Get Agent Details
      GET
    • Update Agent
      PUT
    • Partial Update Agent
      PATCH
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
      GET
    • Create Broadcast
      POST
    • Get Broadcast Details
      GET
    • Update Broadcast
      PUT
    • Partial Update Broadcast
      PATCH
    • Delete Broadcast
      DELETE
  • Conversation
    • Calls
      • Get Calls List
      • Get Call By ID
    • SMS
      • Get SMS Conversations
        GET
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  1. SMS

Get SMS Conversations

GET
https://platform-api.convirza.com/v3/conversations/sms
SMS
Last modified:2026-04-03 14:27:57
Returns a paginated list of SMS conversations scoped to the organizational units accessible to the authenticated user.
Date filtering (optional, defaults to last 7 days)
By default, returns conversations from the last 7 days (UTC). Use start and end parameters to specify a custom date range.
Conversation types (type)
Control which inbox view is returned:
allOpen (default) — all open conversations across the organization.
assignedToYou — conversations assigned to the authenticated agent.
unassigned — open conversations not yet assigned to any agent.
close — closed/resolved conversations.
Search
The search field performs a full-text match against the contact name and phone number. Maximum 255 characters. Partial matches are supported.
Pagination
Uses 0-based offset pagination. offset=0 returns the first page, offset=10 skips the first 10 items. limit controls page size (default 7, maximum 200). The response includes total so clients can compute page count.
Sorting
Use order=desc (default) for newest-first or order=asc for oldest-first, based on the last message timestamp.
Authorization
Results are automatically filtered to the org units accessible to the authenticated user. If the user session cannot be resolved to an organization scope, a 403 is returned.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Query Params

Responses

🟢200
application/json
SMS conversation list returned successfully
Body

🟠400
🟠401
🟠403
🟠404
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://platform-api.convirza.com/v3/conversations/sms?offset&limit&type&search&order&start&end' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "code": 200,
    "message": "Success",
    "data": {
        "total": 42,
        "conversation": [
            {
                "conversation_id": 987654,
                "phone_number": "18015557654",
                "first_response_time": "00:03:21",
                "avg_response_time": "00:04:15",
                "sms_type": "incoming",
                "conversation_started": "2026-03-05T10:30:00.000Z",
                "conversation_updated": "2026-03-05T10:35:00.000Z",
                "source": "18015551234",
                "source_name": "John Doe",
                "conversation_status": "unread",
                "ct_user_id": 501,
                "pin": true,
                "message": "Can you call me back?",
                "unread_count": 2,
                "agent": "John Doe",
                "closed_at": "2026-03-05T11:00:00.000Z"
            }
        ]
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}
Modified at 2026-04-03 14:27:57
Previous
Get Call By ID
Next
List Ad Sources
Built with