> ## Documentation Index > Fetch the complete documentation index at: https://docs.goosybear.ai/llms.txt > Use this file to discover all available pages before exploring further. # Call ads.read_board > Read a campaign's targeting, sizes and launch — 'what is it targeting', 'who sees it', 'did it land on Meta?', 'where do the ad sizes stand?'. Returns its targeting (who it reaches, the places it runs and the age band), its ads, each by its creative_id with its words and whether it is kept and drawn, the planned ideas while they wait for a yes, what the campaign's ads run is doing now, its sizes made of needed, its start date, and where its launch is — waiting on an approve, still on its way, on the platform paused with the platform's own campaign id, or refused with the reason. Call it in this turn for every question about who the campaign reaches or where it runs ('where does it run'), its ads ('what ads do we have'), its sizes or an approved launch ('did it launch?', 'did it go through?'), and answer from this read — never from an earlier reply, and never by raising the launch card again. Leave campaign_id out to read the campaign on screen; the platform's own campaign id is never a campaign_id. Call it before keeping, setting aside or rewording ads by their place ('the first one'), so each is named by its creative_id. It reads only: it changes, draws and spends nothing — when they asked to keep, set aside or reword, call `ads.keep` or `ads.set_words` next, in the same turn, and say it is done only from that tool's result. Not for whether the campaign is ready to launch — that is `ads.launch_check`. Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one. ## OpenAPI ````yaml /openapi.json post /api/v1/tools/ads.read_board openapi: 3.1.0 info: title: Goosy Bear API version: 1.0.0-beta summary: Manage workspace content, projects, Data tables, Pages, library and credits. description: >- BETA. This API is in beta: paths, request shapes and response envelopes may change, and every response carries an `x-goosy-api: beta` header for as long as that is true. A change is additive, or it is deprecated first: a response to a call that uses a deprecated feature carries `Deprecation` and `Sunset` headers, and nothing is removed until at least 90 days after its deprecation. Pin the OpenAPI document you generated against and re-generate when it changes. servers: - url: https://app.goosybear.ai description: Production security: - tenantApiKey: [] paths: /api/v1/tools/ads.read_board: post: tags: - ads summary: Call ads.read_board description: >- Read a campaign's targeting, sizes and launch — 'what is it targeting', 'who sees it', 'did it land on Meta?', 'where do the ad sizes stand?'. Returns its targeting (who it reaches, the places it runs and the age band), its ads, each by its creative_id with its words and whether it is kept and drawn, the planned ideas while they wait for a yes, what the campaign's ads run is doing now, its sizes made of needed, its start date, and where its launch is — waiting on an approve, still on its way, on the platform paused with the platform's own campaign id, or refused with the reason. Call it in this turn for every question about who the campaign reaches or where it runs ('where does it run'), its ads ('what ads do we have'), its sizes or an approved launch ('did it launch?', 'did it go through?'), and answer from this read — never from an earlier reply, and never by raising the launch card again. Leave campaign_id out to read the campaign on screen; the platform's own campaign id is never a campaign_id. Call it before keeping, setting aside or rewording ads by their place ('the first one'), so each is named by its creative_id. It reads only: it changes, draws and spends nothing — when they asked to keep, set aside or reword, call `ads.keep` or `ads.set_words` next, in the same turn, and say it is done only from that tool's result. Not for whether the campaign is ready to launch — that is `ads.launch_check`. Every result names the workspace it ran in. Say which workspace the answer is about. When the account has more than one workspace and none is selected, this tool refuses with `workspace_ambiguous` and lists the choices — offer them, never pick one. operationId: call_ads_read_board parameters: - name: x-request-id in: header required: false description: >- Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from `A–Z a–z 0–9 . _ : -`, starting with a letter or digit; anything else is replaced by a generated id. schema: type: string maxLength: 128 requestBody: required: false content: application/json: schema: type: object properties: campaign_id: type: string description: >- The campaign's id. Leave it out to use the campaign the person is looking at. workspace: type: string minLength: 1 description: >- Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed. additionalProperties: false responses: '200': description: >- The call was admitted and dispatched. `ok` says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 x-goosy-tool-error: description: >- `true` when a boundary step refused the call — workspace resolution failed or could not be read. A tool that ran and returned its own typed `ok: false` reports `false` here. **Branch on `ok` in the body for the outcome; this header is the transport-level hint.** schema: type: string enum: - 'true' - 'false' content: application/json: schema: oneOf: - type: object description: The tool ran and answered. properties: ok: type: boolean const: true campaign_id: type: string campaign_name: type: string platform: type: string run: type: string enum: - not_started - drawing - waiting_on_the_ideas - waiting_on_want_more - finished - failed description: >- waiting_on_the_ideas: the planned ideas wait for a yes (`ads.draft_creatives`) before any picture is drawn; waiting_on_want_more: the run asks whether to draw more (`ads.more` or `ads.done`). ideas: type: array items: type: string ads: type: array items: type: object properties: creative_id: type: string position: type: integer name: type: string kept: type: boolean drawn: type: boolean headline: type: - string - 'null' primary_text: type: - string - 'null' description: type: - string - 'null' call_to_action: type: - string - 'null' required: - creative_id - position - name - kept - drawn - headline - primary_text - description - call_to_action additionalProperties: false daily_budget_cents: type: integer minimum: 0 ad_count: type: integer minimum: 0 live: type: boolean sizes: type: object properties: made: type: integer minimum: 0 needed: type: integer minimum: 0 drawing: type: integer minimum: 0 required: - made - needed - drawing additionalProperties: false description: >- The sizes the platform needs for the kept ads, counted from the campaign's own rows: made of needed, and how many are on their way. When made equals needed every size is done — never say the sizes are still open. Sizes not yet made are Goosy's, made at the approve, never the person's. starts_on: type: - string - 'null' targeting: type: object properties: audience: type: string places: type: - string - 'null' ages: type: - string - 'null' required: - audience - places - ages additionalProperties: false platform_campaign: anyOf: - type: object properties: label: type: string id: type: string required: - label - id additionalProperties: false - type: 'null' launch: type: object properties: state: type: string enum: - not_approved - in_flight - on_platform_paused - on_platform_scheduled - on_platform_live - refused description: >- not_approved: nothing has approved this launch and no card is up — on a launch ask call `ads.approve_launch`, which raises the card; when sentence is set the last launch was refused for that reason and approving again retries it. in_flight: approved, and the launch step has not settled — say it is still on its way. on_platform_paused: the platform has it, paused; nothing spends until it is switched on (`ads.switch_campaign`). on_platform_scheduled: switched on, and it starts serving on its start date; nothing spends before then. on_platform_live: switched on and serving; it spends its daily amount until paused. refused: the launch step refused; say its sentence. provider_campaign_id: type: - string - 'null' sentence: type: - string - 'null' required: - state - provider_campaign_id - sentence additionalProperties: false workspace: type: string description: The slug of the workspace this call ran in. working_in: type: object properties: label: type: string description: 'The chip words — e.g. "working in: Acme Main".' note: type: string description: >- Why this workspace — e.g. "your default", "this call only". workspace: type: string description: The resolved workspace's slug. source: type: string enum: - call-override - key-pin - stored-default - sole-reachable description: >- Which rung of the R7 precedence resolved the workspace. required: - label - note - workspace - source additionalProperties: false description: >- Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result. required: - ok - ad_count - ads - campaign_id - campaign_name - daily_budget_cents - ideas - launch - live - platform - platform_campaign - run - sizes - starts_on - targeting - working_in - workspace - $ref: '#/components/schemas/ToolRefusal' '400': description: >- The request could not be used: the body is present but not a JSON object (`tenant_api.malformed_body`); it is a top-level array carrying more messages than this endpoint accepts (`tenant_mcp.batch_too_large`); or the `Idempotency-Key` header is malformed (`tenant_api.idempotency_key_invalid`), disagrees with the body's `idempotency_key` (`tenant_api.idempotency_key_conflict`), or was sent to an action that cannot replay a retry (`tenant_api.idempotency_unsupported`). Nothing ran. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: >- No bearer credential, or one that did not resolve. Deliberately ONE undifferentiated answer for absent / unknown / revoked / expired, so the endpoint is never an oracle over the key space. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- The credential is good but the surface is not open to it — the platform or account API switch is off, or the holder lacks the `api.access` capability. The `code` says which. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: >- No such tool. The body names no tool and is identical for every unrecognised name. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Over this key's per-minute cap. Carries `Retry-After` and `error.retry_after_seconds`. headers: x-goosy-api: description: Present while this API is in beta; the value is `beta`. schema: type: string const: beta x-request-id: description: >- This request's id: the `x-request-id` you sent when it was well formed, otherwise one generated for you. Quote it to support; it is recorded on every audit row the call wrote. schema: type: string Deprecation: description: >- RFC 9745: this refusal's nested `error` object is deprecated, since this instant (`@`). schema: type: string Sunset: description: >- RFC 8594: the nested `error` object may be removed after this date (2026-12-31). schema: type: string Link: description: The page that says what to read instead (`rel="deprecation"`). schema: type: string RateLimit-Limit: description: Requests this key may make in a rolling minute. schema: type: integer minimum: 1 RateLimit-Remaining: description: Requests left in the current rolling minute. schema: type: integer minimum: 0 RateLimit-Reset: description: Whole seconds until the window frees more requests. schema: type: integer minimum: 1 Retry-After: description: Whole seconds to wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: ToolRefusal: type: object properties: ok: type: boolean const: false code: type: string description: >- The typed reason — e.g. `workspace_ambiguous`, `invalid_arguments`, or the tool's own failure code. message: type: string description: A sentence a person can act on. workspaces: type: array items: type: string description: 'On a workspace refusal: the slugs this key may pass as `workspace`.' issues: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false description: 'On `invalid_arguments`: which fields failed, and why.' required: - ok - code - message additionalProperties: false description: A call that was admitted and dispatched, and did not succeed. Error: type: object properties: ok: type: boolean const: false code: type: string description: >- The typed refusal code — e.g. `tenant_mcp.surface_disabled`, `tenant_mcp.rate_limited`. message: type: string description: A sentence a person can act on. retry_after_seconds: type: number description: 'On a 429: whole seconds to wait. Mirrors `Retry-After`.' error: type: object properties: code: type: string message: type: string retry_after_seconds: type: number required: - code - message additionalProperties: false description: >- Deprecated: the same values as the top-level fields, kept until 2026-12-31. Read `code` and `message` at the top level. required: - ok - code - message - error additionalProperties: false description: >- A request the boundary refused before dispatching anything. The same shape the MCP endpoint answers its own refusals with, and the same top-level fields a dispatched call's refusal carries, so one client branch covers both. securitySchemes: tenantApiKey: type: http scheme: bearer description: >- An API key minted at Settings › API & MCP. Send it as `Authorization: Bearer `. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (`GOOSY_API_KEY`), never in a committed file. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.