Skip to main content
GET
/
v2
/
lists
/
{list_id}
{
  "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"
}
Returns the full details of a single sending list, including an accurate count of active contacts.

Path Parameters

list_id
integer
required
The unique identifier of the sending list.

Response Fields

id
integer
Unique identifier for the sending list.
phone_number
string
The phone number associated with the list in E.164 format (e.g. +12025551234).
brand_name
string
The brand name registered for this sending list.
list_name
string
The display name of the sending list.
list_type
string
The SMS provider used for this list. One of: lime, infobip, twilio, cm.
status
string
Current status of the list. One of: active, paused, suspended, deleted.
contact_count
integer
The number of active contacts on this list. Calculated via aggregation of active ListContacts.
created_at
datetime
ISO 8601 timestamp of when the list was created.

Examples

cURL
curl -X GET "https://app.tracklysms.com/api/v2/lists/42" \
  -H "X-Api-Key: trk_your_api_key_here"
Python
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")
Node.js
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 StatusError CodeDescription
401unauthorizedAPI key is missing or invalid.
404not_foundNo 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