Audience List

Audience list

curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/audience-list \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://www.tryunleashx.com/api/v1/global/audience-list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.tryunleashx.com/api/v1/global/audience-list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/audience-list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("token", "<token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/audience-list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["token"] = '<token>'

response = http.request(request)
puts response.read_body

{
  "datalist": [
    {}
  ],
  "headers": [
    {}
  ],
  "pagination": {
    "totalRecords": 123,
    "totalPages": 123,
    "currentPage": 123,
    "limit": 123
  }
}

GET

audience-list

Audience list

curl --request GET \
  --url https://www.tryunleashx.com/api/v1/global/audience-list \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://www.tryunleashx.com/api/v1/global/audience-list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.tryunleashx.com/api/v1/global/audience-list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/audience-list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("token", "<token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/audience-list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["token"] = '<token>'

response = http.request(request)
puts response.read_body

{
  "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

Parameter	Type	Required	Description
`campaign_id`	number	Yes	Campaign identifier
`page`	number	No	Page number (default: `1`)
`limit`	number	No	Records per page (default: `10`)
`mobile_no`	string	No	Partial mobile number search (LIKE)
`status`	number \| array	No	Audience status filter (see codes below)
`call_status`	string \| array	No	Filter by call status
`first_status`	string \| array	No	Filter by first call status
`last_status`	string \| array	No	Filter by last call status
`attempt`	number \| array	No	Filter by number of attempts made
`is_new`	boolean	No	If `true`, returns simplified audience format (default: `false`)

Audience Status Codes

Code	Status
`0`	Fresh
`1`	Completed
`2`	Halted
`3`	Inqueue

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

Show child attributes

Campaign Details

Download Audience Format

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Users

Endpoint

Query Parameters

Audience Status Codes

Response (is_new=false — default)

Response (is_new=true — simplified)

Example cURL

Headers

Query Parameters

Response

​Endpoint

​Query Parameters

​Audience Status Codes

​Response (is_new=false — default)

​Response (is_new=true — simplified)

​Example cURL

Headers

Query Parameters

Response

Endpoint

Query Parameters

Audience Status Codes

Response (is_new=false — default)

Response (is_new=true — simplified)

Example cURL