Skip to main content
GET
/
audience-list
Audience list
curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/audience-list \
  --header 'token: <token>'
{
  "datalist": [
    {}
  ],
  "headers": [
    {}
  ],
  "pagination": {
    "totalRecords": 123,
    "totalPages": 123,
    "currentPage": 123,
    "limit": 123
  }
}
Use this endpoint to retrieve a paginated list of audience records for a campaign, with optional filters and two response modes.

Endpoint

GET /audience-list Authentication: Required (workspace auth)

Query Parameters

ParameterTypeRequiredDescription
campaign_idnumberYesCampaign identifier
pagenumberNoPage number (default: 1)
limitnumberNoRecords per page (default: 10)
mobile_nostringNoPartial mobile number search (LIKE)
statusnumber | arrayNoAudience status filter (see codes below)
call_statusstring | arrayNoFilter by call status
first_statusstring | arrayNoFilter by first call status
last_statusstring | arrayNoFilter by last call status
attemptnumber | arrayNoFilter by number of attempts made
is_newbooleanNoIf true, returns simplified audience format (default: false)

Audience Status Codes

CodeStatus
0Fresh
1Completed
2Halted
3Inqueue

Response (is_new=false — default)

{
  "datalist": [
    {
      "id": 101,
      "mobile_no": "+12025550123",
      "input_data": { "name": "John Doe", "plan": "premium" },
      "total_attempt": "2/3",
      "duration": "2m 30s",
      "last_attempt": "2025-12-10 14:30:00",
      "last_disposition": "Interested",
      "last_call_status": "COMPLETED",
      "status": "Completed",
      "updated_by": "Jane Admin"
    }
  ],
  "headers": [
    { "key": "mobile_no", "label": "Mobile Number" },
    { "key": "input_data", "label": "Input Data" },
    { "key": "status", "label": "Lead Status" },
    { "key": "total_attempt", "label": "Attempt" },
    { "key": "last_call_status", "label": "Call Status" },
    { "key": "duration", "label": "Duration" },
    { "key": "last_disposition", "label": "Disposition" },
    { "key": "last_attempt", "label": "Last Attempt" },
    { "key": "updated_by", "label": "Modified By" }
  ],
  "pagination": {
    "totalRecords": 500,
    "totalPages": 50,
    "currentPage": 1,
    "limit": 10
  }
}

Response (is_new=true — simplified)

{
  "datalist": [
    {
      "id": 101,
      "mobile_no": "+12025550123",
      "name": "John Doe",
      "plan": "premium"
    }
  ],
  "headers": [
    { "key": "mobile_no", "label": "Mobile Number" },
    { "key": "name", "label": "Name" },
    { "key": "plan", "label": "Plan" }
  ],
  "metadata": [
    { "key": "mobile_no", "label": "Mobile Number" },
    { "key": "name", "label": "Name" }
  ],
  "pagination": {
    "totalRecords": 500,
    "totalPages": 50,
    "currentPage": 1,
    "limit": 10
  }
}

Example cURL

curl -X GET "https://www.tryunleashx.com/api/v1/global/audience-list?campaign_id=42&page=1&limit=10" \
  -H "Authorization: <api_key>"

Headers

token
string
required

API token for authentication

Query Parameters

campaign_id
integer
required

Campaign identifier

page
integer

Page number (default: 1)

limit
integer

Records per page (default: 10)

mobile_no
string

Partial mobile number search

status
enum<integer>

0=Fresh, 1=Completed, 2=Halted, 3=Inqueue

Available options:
0,
1,
2,
3
call_status
string

Filter by call status

attempt
integer

Filter by attempt count

is_new
boolean

If true, returns simplified audience format

Response

Audience list retrieved successfully

datalist
object[]
headers
object[]
pagination
object