Skip to main content
GET
/
v2
/
audiences
curl -X GET "https://app.tracklysms.com/api/v2/audiences?status=active&page=1&per_page=25" \
  -H "X-Api-Key: trk_your_api_key_here"
{
  "audiences": [
    {
      "id": "664f1a2b3c4d5e6f7a8b9c0d",
      "name": "High-Value Clickers",
      "description": "Contacts who clicked at least 3 times in the last 30 days",
      "source_lists": [101, 102],
      "filter": {
        "operator": "AND",
        "conditions": [
          {
            "conditionType": "time",
            "field": "last_clicked_at",
            "operator": "within",
            "value": 30,
            "unit": "days"
          },
          {
            "conditionType": "count",
            "field": "click_count",
            "operator": "gte",
            "value": 3
          }
        ]
      },
      "cached_size": 12480,
      "cached_size_updated_at": "2025-11-15T08:30:00",
      "status": "active",
      "created_at": "2025-10-01T14:22:00"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}
Returns a paginated list of audiences belonging to your account.

Query Parameters

status
string
default:"active"
Filter audiences by status. Accepted values: active, archived.
page
integer
default:1
Page number for pagination.
per_page
integer
default:50
Number of audiences per page. Maximum: 100.

Response Fields

audiences
array
Array of audience objects.
pagination
object

Examples

curl -X GET "https://app.tracklysms.com/api/v2/audiences?status=active&page=1&per_page=25" \
  -H "X-Api-Key: trk_your_api_key_here"
{
  "audiences": [
    {
      "id": "664f1a2b3c4d5e6f7a8b9c0d",
      "name": "High-Value Clickers",
      "description": "Contacts who clicked at least 3 times in the last 30 days",
      "source_lists": [101, 102],
      "filter": {
        "operator": "AND",
        "conditions": [
          {
            "conditionType": "time",
            "field": "last_clicked_at",
            "operator": "within",
            "value": 30,
            "unit": "days"
          },
          {
            "conditionType": "count",
            "field": "click_count",
            "operator": "gte",
            "value": 3
          }
        ]
      },
      "cached_size": 12480,
      "cached_size_updated_at": "2025-11-15T08:30:00",
      "status": "active",
      "created_at": "2025-10-01T14:22:00"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 1,
    "total_pages": 1
  }
}

Error Codes

HTTP StatusError CodeDescription
401unauthorizedAPI key is missing or invalid

Next Steps

Creating Audiences

Build audiences in the UI

Create Schedule

Schedule a campaign to an audience