curl --request POST \
--url https://app.goosybear.ai/api/v1/tools/ads.read_board \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"campaign_id": "<string>",
"workspace": "<string>"
}
'import requests
url = "https://app.goosybear.ai/api/v1/tools/ads.read_board"
payload = {
"campaign_id": "<string>",
"workspace": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({campaign_id: '<string>', workspace: '<string>'})
};
fetch('https://app.goosybear.ai/api/v1/tools/ads.read_board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.goosybear.ai/api/v1/tools/ads.read_board",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'campaign_id' => '<string>',
'workspace' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.goosybear.ai/api/v1/tools/ads.read_board"
payload := strings.NewReader("{\n \"campaign_id\": \"<string>\",\n \"workspace\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.goosybear.ai/api/v1/tools/ads.read_board")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_id\": \"<string>\",\n \"workspace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.goosybear.ai/api/v1/tools/ads.read_board")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign_id\": \"<string>\",\n \"workspace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"campaign_id": "<string>",
"campaign_name": "<string>",
"platform": "<string>",
"run": "not_started",
"ideas": [
"<string>"
],
"ads": [
{
"creative_id": "<string>",
"position": 123,
"name": "<string>",
"kept": true,
"drawn": true,
"headline": "<string>",
"primary_text": "<string>",
"description": "<string>",
"call_to_action": "<string>"
}
],
"daily_budget_cents": 1,
"ad_count": 1,
"live": true,
"sizes": {
"made": 1,
"needed": 1,
"drawing": 1
},
"starts_on": "<string>",
"targeting": {
"audience": "<string>",
"places": "<string>",
"ages": "<string>"
},
"platform_campaign": {
"label": "<string>",
"id": "<string>"
},
"launch": {
"state": "not_approved",
"provider_campaign_id": "<string>",
"sentence": "<string>"
},
"workspace": "<string>",
"working_in": {
"label": "<string>",
"note": "<string>",
"workspace": "<string>",
"source": "call-override"
}
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}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.
curl --request POST \
--url https://app.goosybear.ai/api/v1/tools/ads.read_board \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"campaign_id": "<string>",
"workspace": "<string>"
}
'import requests
url = "https://app.goosybear.ai/api/v1/tools/ads.read_board"
payload = {
"campaign_id": "<string>",
"workspace": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({campaign_id: '<string>', workspace: '<string>'})
};
fetch('https://app.goosybear.ai/api/v1/tools/ads.read_board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.goosybear.ai/api/v1/tools/ads.read_board",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'campaign_id' => '<string>',
'workspace' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.goosybear.ai/api/v1/tools/ads.read_board"
payload := strings.NewReader("{\n \"campaign_id\": \"<string>\",\n \"workspace\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.goosybear.ai/api/v1/tools/ads.read_board")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"campaign_id\": \"<string>\",\n \"workspace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.goosybear.ai/api/v1/tools/ads.read_board")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"campaign_id\": \"<string>\",\n \"workspace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"campaign_id": "<string>",
"campaign_name": "<string>",
"platform": "<string>",
"run": "not_started",
"ideas": [
"<string>"
],
"ads": [
{
"creative_id": "<string>",
"position": 123,
"name": "<string>",
"kept": true,
"drawn": true,
"headline": "<string>",
"primary_text": "<string>",
"description": "<string>",
"call_to_action": "<string>"
}
],
"daily_budget_cents": 1,
"ad_count": 1,
"live": true,
"sizes": {
"made": 1,
"needed": 1,
"drawing": 1
},
"starts_on": "<string>",
"targeting": {
"audience": "<string>",
"places": "<string>",
"ages": "<string>"
},
"platform_campaign": {
"label": "<string>",
"id": "<string>"
},
"launch": {
"state": "not_approved",
"provider_campaign_id": "<string>",
"sentence": "<string>"
},
"workspace": "<string>",
"working_in": {
"label": "<string>",
"note": "<string>",
"workspace": "<string>",
"source": "call-override"
}
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}{
"ok": false,
"code": "<string>",
"message": "<string>",
"error": {
"code": "<string>",
"message": "<string>",
"retry_after_seconds": 123
},
"retry_after_seconds": 123
}Authorizations
An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. 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.
Headers
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.
128Body
The campaign's id. Leave it out to use the campaign the person is looking at.
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.
1Response
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.
- Option 1
- Option 2
The tool ran and answered.
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).
not_started, drawing, waiting_on_the_ideas, waiting_on_want_more, finished, failed Show child attributes
Show child attributes
x >= 0x >= 0The 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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The slug of the workspace this call ran in.
Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.
Show child attributes
Show child attributes