list_microsoft_ad_extensions — Adspirer REST API

List the ad extensions in the account's shared library (sitelinks, callouts, etc) with their ids and text, so you can reuse and associate them

Endpoint

Headers

Description

List the ad extensions in the account's shared library (sitelinks, callouts, etc) with their ids and text, so you can reuse and associate them. Search/filter/sort/paginate.

Request body

Field	Type	Description
`account_id`	`string` optional	Microsoft Advertising ad account id (numeric AccountId — NOT the 8-character account number shown in the UI). Get it from list_microsoft_accounts. Required when more than one account is connected; may be omitted with exactly one. `customer_id` is accepted as an alias. If the tool replies that several accounts are connected, re-run with this set — that reply is NOT a connection problem.
`customer_id`	`string` optional	Alias of account_id (the ad account id, not the manager id).
`query`	`string` optional	Free-text search — case-insensitive substring match across name/id and, for ads/keywords, the copy (headlines, descriptions, keyword text). Leave empty for all.
`status_filter`	`string` optional	Filter by status, comma-separated (e.g. 'Active' or 'Active,Paused'). 'all' or empty = every status.
`type_filter`	`string` optional	Filter by the entity's type field, comma-separated (campaign_type / ad_group_type / ad type / match_type / budget_type depending on the tool). 'all' or empty = every type.
`started_after`	`string` optional	Date filter (YYYY-MM-DD): only entities whose START date is on/after this. Applies to levels that have a start date (campaigns, ad groups); entities with no explicit start date are excluded while a date filter is active.
`started_before`	`string` optional	Date filter (YYYY-MM-DD): only entities whose START date is on/before this.
`sort_by`	`string` optional	Field to sort by (e.g. name, status, daily_budget, cpc_bid, bid, amount). Any returned field name.
`sort_order`	`string` optional	'asc' (default) or 'desc'. default: `"asc"`
`offset`	`integer` optional	Pagination offset — skip this many results (default 0). Use with limit to page through. default: `0`
`limit`	`integer` optional	Max results per page (default 50). The response reports total, filtered and has_more. default: `50`
`extension_types`	`string` optional	Which extension types to list (space list, e.g. 'Sitelinks Callouts'). Default = common set.

Field

Type

Description

account_id

string optional

Microsoft Advertising ad account id (numeric AccountId — NOT the 8-character account number shown in the UI). Get it from list_microsoft_accounts. Required when more than one account is connected; may be omitted with exactly one. `customer_id` is accepted as an alias. If the tool replies that several accounts are connected, re-run with this set — that reply is NOT a connection problem.

customer_id

string optional

Alias of account_id (the ad account id, not the manager id).

query

string optional

Free-text search — case-insensitive substring match across name/id and, for ads/keywords, the copy (headlines, descriptions, keyword text). Leave empty for all.

status_filter

string optional

Filter by status, comma-separated (e.g. 'Active' or 'Active,Paused'). 'all' or empty = every status.

type_filter

string optional

Filter by the entity's type field, comma-separated (campaign_type / ad_group_type / ad type / match_type / budget_type depending on the tool). 'all' or empty = every type.

started_after

string optional

Date filter (YYYY-MM-DD): only entities whose START date is on/after this. Applies to levels that have a start date (campaigns, ad groups); entities with no explicit start date are excluded while a date filter is active.

started_before

string optional

Date filter (YYYY-MM-DD): only entities whose START date is on/before this.

sort_by

string optional

Field to sort by (e.g. name, status, daily_budget, cpc_bid, bid, amount). Any returned field name.

sort_order

string optional

'asc' (default) or 'desc'. default: "asc"

offset

integer optional

Pagination offset — skip this many results (default 0). Use with limit to page through. default: 0

limit

integer optional

Max results per page (default 50). The response reports total, filtered and has_more. default: 50

extension_types

string optional

Which extension types to list (space list, e.g. 'Sitelinks Callouts'). Default = common set.

Example request

Example responses

200 — Success

{ "success": true, "data": { "text": "(tool-specific textual output for list_microsoft_ad_extensions)", "quota": { "used": 42, "limit": 150, "tier": "plus", "period_end": "2026-05-01" } }, "tool": "list_microsoft_ad_extensions" }

400 — Tool-level error (bad arguments / multi-account selection)

{ "success": false, "error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n - Acme Holdings (ad_account_id=\"act_123456789\")\n - Acme EU (ad_account_id=\"act_987654321\")", "is_error": true, "tool": "list_microsoft_ad_extensions" }

402 — Quota exhausted

{ "success": false, "error": "\ud83d\udea8 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.", "is_error": true, "tool": "list_microsoft_ad_extensions", "quota": { "used": 150, "limit": 150, "tier": "plus", "period_end": "2026-05-01", "upgrade_url": "https://adspirer.ai" } }

Try it live

Interactive: Swagger UI

Machine-readable: OpenAPI 3.1 spec · llms-full.txt

More tools: Microsoft Advertising · All tools