Get Custom Audiences – NewsBreak Ad Manager

Lists the custom audiences available to an ad account. The list includes audiences the account owns and audiences other accounts have shared with it.

End Point GET https://business.newsbreak.com/business-api/v1/audience/getList

Header

Field	Required	Data Type	Description
Access-Token	Y	string	Authorized access token.

Request Parameters

Field	Required	Data Type	Description
adAccountId	Y	string	ID of the ad account.
pageNo	Y	integer	Page number.
pageSize	Y	integer	Page size. Available values: 5, 10, 20, 50, 100, 200, 500.

Example

curl --location --request GET 'https://business.newsbreak.com/business-api/v1/audience/getList?adAccountId=1234567&pageNo=1&pageSize=20' \
-H 'Access-Token:{{Access-Token}}'

Response Parameters

Field	Data Type	Description
code	int	Status code, see Return Codes
errMsg	string	Error message when code!=0
data	object	Response object.
.pageNo	int	Number of current page.
.pageSize	int	Size of current page.
.total	int	Total size for this search.
.hasNext	bool	Whether there is a next page.
.list	object[]	Each item is a custom audience.
..id	string	Audience ID.
..name	string	Audience name.
..adAccountId	string	ID of the account that owns the audience — not necessarily the account queried, for a shared audience.
..type	string	`FILE` for file-based audiences. Audiences built in NewsBreak Ads Manager may report other types.
..status	string	`QUEUED`, `AVAILABLE` or `EXPIRING`. Only `AVAILABLE` audiences can be targeted.
..size	int	Number of matched NewsBreak users. Absent until processing completes.
..fileType	string	`EMAIL` or `DEVICE_ID`. Absent for audiences that are not file-based.
..createTime	string	Creation time, Unix seconds.
..updateTime	string	Last update time, Unix seconds.

Audiences are ordered newest-shared first.

Example

{
    "code": 0,
    "data": {
        "pageNo": 1,
        "pageSize": 20,
        "total": 2,
        "hasNext": false,
        "list": [
            {
                "id": "1234567890123456789",
                "name": "Spring campaign customers",
                "adAccountId": "1234567",
                "type": "FILE",
                "status": "AVAILABLE",
                "size": 48213,
                "fileType": "EMAIL",
                "createTime": "1755500000",
                "updateTime": "1755590000"
            },
            {
                "id": "1234567890123456790",
                "name": "Churned users",
                "adAccountId": "1234567",
                "type": "FILE",
                "status": "QUEUED",
                "fileType": "EMAIL",
                "createTime": "1755600000",
                "updateTime": "1755600000"
            }
        ]
    }
}

Note for whoever publishes this: the old reference documented the paged list key as rows. The API actually returns list. Worth not copying the old mistake forward.

Related articles