Get settings
Get current settings (budget, targeting, schedule, placements, optimization) for one or MANY nodes.
Tool name: get-settings.
Get current settings (budget, targeting, schedule, placements, optimization) for one or MANY nodes. To read several nodes, pass them all in nodes in a SINGLE call, do NOT call this tool once per node. One call with nodes: [{nodeId, nodeType}, …] returns every node's settings at once and is dramatically faster than repeated single-node calls. Use nodeId+nodeType only for a single node.
When to use
Read configured settings (budget, targeting, schedule, placements, optimization). Use this BEFORE updateSettings so you know current state. Reading more than one node? Pass them all in nodes in ONE call. NOT for details/creative, use getAdsetDetails/getAdDetails.
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | No |
Input
| Field | Type | Required | Description |
|---|---|---|---|
campaignLaunchId | string | Yes | Campaign launch ID (a.k.a. batch ID). Read it from the Current Context block when one is in scope, or resolve it from a mention via listAccountCampaigns / the campaign tree when the user @-mentioned a different launch. |
nodeId | string | No | ID of the node (single-node form; omit when using nodes) |
nodeType | string | No | Type of the node (single-node form). One of campaign, adset, ad. |
nodes | object[] | No | Read MANY nodes in one call (max 60). Strongly preferred over repeated single-node calls. At least 1 item, at most 60 items. |
nodes[].nodeId | string | Yes | ID of the node |
nodes[].nodeType | string | Yes | Type of the node. One of campaign, adset, ad. |
Output
The tool catalog does not declare an output schema for this tool.
REST equivalent
GET /v1/brands/{brandId}/launches/{launchId}/settings, Get settings. CLI: koast get-settings.