Fetches one custom audience, including the accounts it is shared with.
End Point GET https://business.newsbreak.com/business-api/v1/audience/get/{audienceId}
Header
| Field | Required | Data Type | Description |
|---|---|---|---|
| Access-Token | Y | string | Authorized access token. |
Path Parameters
| Field | Required | Data Type | Description |
|---|---|---|---|
| audienceId | Y | string | ID of the audience. |
Example
curl --location --request GET 'https://business.newsbreak.com/business-api/v1/audience/get/1234567890123456789' \
-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. |
| .id | string | Audience ID. |
| .name | string | Audience name. |
| .adAccountId | string | ID of the account that owns the audience. |
| .type | string | FILE for file-based audiences. |
| .status | string | QUEUED, AVAILABLE or EXPIRING. |
| .size | int | Number of matched NewsBreak users. Absent until processing completes. |
| .fileType | string | EMAIL or DEVICE_ID. |
| .sharedAdAccountIds | string[] | Accounts the audience is available to, limited to those you can read. |
| .createTime | string | Creation time, Unix seconds. |
| .updateTime | string | Last update time, Unix seconds. |
sharedAdAccountIds always includes the owning account. It is returned by this endpoint only — the list endpoint omits it.
Example
{
"code": 0,
"data": {
"id": "1234567890123456789",
"name": "Spring campaign customers",
"adAccountId": "1234567",
"type": "FILE",
"status": "AVAILABLE",
"size": 48213,
"fileType": "EMAIL",
"sharedAdAccountIds": ["1234567", "7654321"],
"createTime": "1755500000",
"updateTime": "1755590000"
}
}Errors
| Code | Meaning |
|---|---|
| 403 | The audience is not shared with any ad account your access token can read. |