ghl_ad_fb_audience_list
Retrieve Facebook custom audiences for a location and ad account, filter by audience type, and paginate results or limit returned fields for inventory and campaign planning.
Instructions
Get custom audiences
Retrieve Facebook custom audiences for a location. Without limit the response is a plain array. When limit is provided (max 100) the response is a paginated { customAudiences, paging } envelope; pass after (from paging.next) to fetch the next batch. By default each item is returned in full; pass projection (comma-separated, dot-notation for nested fields, e.g. ?projection=id,name,dataSource.type) to return only the requested fields — any value outside the known field set is rejected.
Endpoint: GET /ad-publishing/facebook/custom-audience (Version header: v3; source: v3/ad-publishing-v3.json)
OAuth scopes: adPublishing.readonly
Pagination params: limit — pass them to page through full result sets.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"locationId": "<locationId>",
"type": "<type>",
"adAccountId": "<adAccountId>"
},
"name": "ghl_ad_fb_audience_list"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Audience list type | |
| after | No | Opaque cursor for the next batch, taken from the previous response paging.next | |
| limit | No | Page size for a paginated fetch (max 100). When set, the response is a { customAudiences, paging } envelope instead of a plain array. | |
| source | No | Audience data source | |
| locationId | Yes | Location identifier | |
| projection | No | Fields to return on each item, comma-separated (e.g. ?projection=id,name,dataSource.type). When set, only the requested fields are returned. Nested fields use dot-notation; naming a parent (e.g. dataSource) returns the whole nested object. Any value outside the known field set is rejected. Omit the param entirely to receive the full item as-is. | |
| adAccountId | Yes | Ad account identifier |