List conversation assignments
Lists the conversations that have been assigned, released or given a status at some point, optionally filtered by
team member and status. Conversations that never had an assignment or status are not included, so
team_member=unassigned lists released conversations rather than every conversation without an assignee.
Send the parameters as query string.
Base URL:
GET: https://api.smsgatewayapi.com/v1/conversations/assignments
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Developer › API & Webhooks › API credentials | Required |
| client_secret | API client secret | A cs_ credential, shown once when you create it under Developer › API & Webhooks › API credentials | Required |
| team_member | id of a team member or 'unassigned' | Public ID (sub_...) or numeric ID of a team member to only list their conversations, or unassigned for released conversations | Optional |
| status | open, pending or closed | Only list conversations with this status | Optional |
| limit | Maximum results per page | Default up to 1000, can't be bigger than 2000 | Optional |
| page | Page of results | Default up to 1 | Optional |
<?php //PHP - cURL $ch = curl_init(); $url = "https://api.smsgatewayapi.com/v1/conversations/assignments"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required)
curl_setopt($ch, CURLOPT_URL, "$url"); curl_setopt($ch, CURLOPT_POST, false); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET'); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_VERBOSE, true); curl_setopt($ch, CURLOPT_HTTPHEADER, [ "X-Client-Id: $client_id", "X-Client-Secret: $client_secret", "Content-Type: application/json", ]); $response = curl_exec($ch); ?>
Example request:
GET: https://api.smsgatewayapi.com/v1/conversations/assignments?team_member=sub_3520a1ec234dbabe1232def67e858855&status=open&limit=50
Example success response:
{
"total": 2,
"shown": 2,
"page": 1,
"limit": 50,
"assignments": [
{
"conversation_key": "32470123456",
"assignee": {
"public_id": "sub_3520a1ec234dbabe1232def67e858855",
"name": "alice"
},
"status": "open",
"assigned_at": "2026-09-07 10:15:00"
},
{
"conversation_key": "group:gid_5d41402abc4b2a76b9719d911017c592",
"assignee": {
"public_id": "sub_3520a1ec234dbabe1232def67e858855",
"name": "alice"
},
"status": "open",
"assigned_at": "2026-09-06 16:40:12"
}
]
}
Example error response:
{
"error": 143,
"errorMsg": "Team member not found"
}
