Returns the full details of a single sending list, including an accurate count of active contacts.
Path Parameters
The unique identifier of the sending list.
Response Fields
Unique identifier for the sending list.
The phone number associated with the list in E.164 format (e.g. +12025551234).
The brand name registered for this sending list.
The display name of the sending list.
The SMS provider used for this list. One of: lime, infobip, twilio, cm.
Current status of the list. One of: active, paused, suspended, deleted.
The number of active contacts on this list. Calculated via aggregation of active ListContacts.
ISO 8601 timestamp of when the list was created.
Examples
curl -X GET "https://app.tracklysms.com/api/v2/lists/42" \
-H "X-Api-Key: trk_your_api_key_here"
import requests
response = requests.get(
"https://app.tracklysms.com/api/v2/lists/42",
headers={"X-Api-Key": "trk_your_api_key_here"}
)
data = response.json()
print(f"{data['list_name']} — {data['contact_count']} contacts")
const response = await fetch(
"https://app.tracklysms.com/api/v2/lists/42",
{
headers: {
"X-Api-Key": "trk_your_api_key_here",
},
}
);
const data = await response.json();
console.log(data);
{
"id": 42,
"phone_number": "+12025551234",
"brand_name": "Acme Co",
"list_name": "Acme Promo List",
"list_type": "infobip",
"status": "active",
"contact_count": 15230,
"created_at": "2025-03-15T14:30:00Z"
}
Error Codes
| HTTP Status | Error Code | Description |
|---|
| 401 | unauthorized | API key is missing or invalid. |
| 404 | not_found | No sending list exists with the given ID, or the list has been deleted. |
Next Steps
Contacts Overview
Manage contacts across your lists
List Contacts
View contacts on a specific list