list_walmart_keywords

Walmart Connect Read

List keywords in a Walmart campaign (text, match type, bid, state)

Endpoint

POST https://api.adspirer.ai/api/v1/tools/list_walmart_keywords/execute

Headers

Description

List keywords in a Walmart campaign (text, match type, bid, state). Requires campaign_id.

Request body

All tool arguments are wrapped in an arguments object.

FieldTypeDescription
advertiser_idstring optionalWalmart Advertiser ID. Optional when only one advertiser is connected.
campaign_idstring optionalWalmart Campaign ID.
querystring optionalFree-text search across names/ids/text (case-insensitive).
status_filterstring optionalComma-separated status/state values to keep (e.g. 'live,paused'). Omit for all.
type_filterstring optionalComma-separated type values to keep (campaignType / matchType / placementType).
sort_bystring optionalField to sort by (e.g. name, dailyBudget, bid). Unknown/absent values sort last.
sort_orderstring optionalSort direction (default asc). one of: asc, desc
start_afterstring optionalKeep rows dated on/after this date (YYYY-MM-DD), where the entity has a date.
end_beforestring optionalKeep rows dated on/before this date (YYYY-MM-DD).
offsetinteger optionalRow offset for paging (default 0).
limitinteger optionalMax rows per page (default 50, capped at 200). The response reports total, filtered and has_more.

Example request

{
  "arguments": {
    "sort_order": "asc"
  }
}

Example responses

200 — Success

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

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_walmart_keywords"
}

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_walmart_keywords",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live


Adspirer REST API — get an API key at adspirer.ai/keys · adspirer.ai