curl --request POST \
--url https://app.goosybear.ai/api/v1/tools/leads.capture \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"form": "<string>",
"fields": {},
"utm": {},
"consent": {
"email": true,
"sms": true,
"text": "<string>"
},
"submission_id": "<string>",
"idempotency_key": "<string>",
"workspace": "<string>"
}
'import requests
url = "https://app.goosybear.ai/api/v1/tools/leads.capture"
payload = {
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"form": "<string>",
"fields": {},
"utm": {},
"consent": {
"email": True,
"sms": True,
"text": "<string>"
},
"submission_id": "<string>",
"idempotency_key": "<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({
email: '<string>',
name: '<string>',
phone: '<string>',
form: '<string>',
fields: {},
utm: {},
consent: {email: true, sms: true, text: '<string>'},
submission_id: '<string>',
idempotency_key: '<string>',
workspace: '<string>'
})
};
fetch('https://app.goosybear.ai/api/v1/tools/leads.capture', 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/leads.capture",
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([
'email' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'form' => '<string>',
'fields' => [
],
'utm' => [
],
'consent' => [
'email' => true,
'sms' => true,
'text' => '<string>'
],
'submission_id' => '<string>',
'idempotency_key' => '<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/leads.capture"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"form\": \"<string>\",\n \"fields\": {},\n \"utm\": {},\n \"consent\": {\n \"email\": true,\n \"sms\": true,\n \"text\": \"<string>\"\n },\n \"submission_id\": \"<string>\",\n \"idempotency_key\": \"<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/leads.capture")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"form\": \"<string>\",\n \"fields\": {},\n \"utm\": {},\n \"consent\": {\n \"email\": true,\n \"sms\": true,\n \"text\": \"<string>\"\n },\n \"submission_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"workspace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.goosybear.ai/api/v1/tools/leads.capture")
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 \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"form\": \"<string>\",\n \"fields\": {},\n \"utm\": {},\n \"consent\": {\n \"email\": true,\n \"sms\": true,\n \"text\": \"<string>\"\n },\n \"submission_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"workspace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submission_id": "<string>",
"replayed": true,
"ignored_fields": [
"<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 leads.capture
Send one lead from a form on the workspace’s own website into Goosy — ‘send this signup in as a lead’, ‘capture the demo request from our site’, ‘add the waitlist entry for jane@example.com’. The lead is stored, the submitter becomes the workspace’s contact, the automations that start on a captured lead run, and the contact goes to the workspace’s connected GoHighLevel; with no CRM connected the lead waits and is sent when one is connected. It answers with the lead’s and the contact’s ids, a submission_id, and any fields it ignored. To retry a call, send the same submission_id so nothing is stored twice. Not for a note on someone already a contact — that is contact.note. The contact’s details reach the connected CRM and an automation may message them; this cannot be undone from here.
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/leads.capture \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"form": "<string>",
"fields": {},
"utm": {},
"consent": {
"email": true,
"sms": true,
"text": "<string>"
},
"submission_id": "<string>",
"idempotency_key": "<string>",
"workspace": "<string>"
}
'import requests
url = "https://app.goosybear.ai/api/v1/tools/leads.capture"
payload = {
"email": "<string>",
"name": "<string>",
"phone": "<string>",
"form": "<string>",
"fields": {},
"utm": {},
"consent": {
"email": True,
"sms": True,
"text": "<string>"
},
"submission_id": "<string>",
"idempotency_key": "<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({
email: '<string>',
name: '<string>',
phone: '<string>',
form: '<string>',
fields: {},
utm: {},
consent: {email: true, sms: true, text: '<string>'},
submission_id: '<string>',
idempotency_key: '<string>',
workspace: '<string>'
})
};
fetch('https://app.goosybear.ai/api/v1/tools/leads.capture', 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/leads.capture",
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([
'email' => '<string>',
'name' => '<string>',
'phone' => '<string>',
'form' => '<string>',
'fields' => [
],
'utm' => [
],
'consent' => [
'email' => true,
'sms' => true,
'text' => '<string>'
],
'submission_id' => '<string>',
'idempotency_key' => '<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/leads.capture"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"form\": \"<string>\",\n \"fields\": {},\n \"utm\": {},\n \"consent\": {\n \"email\": true,\n \"sms\": true,\n \"text\": \"<string>\"\n },\n \"submission_id\": \"<string>\",\n \"idempotency_key\": \"<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/leads.capture")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"form\": \"<string>\",\n \"fields\": {},\n \"utm\": {},\n \"consent\": {\n \"email\": true,\n \"sms\": true,\n \"text\": \"<string>\"\n },\n \"submission_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"workspace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.goosybear.ai/api/v1/tools/leads.capture")
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 \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"form\": \"<string>\",\n \"fields\": {},\n \"utm\": {},\n \"consent\": {\n \"email\": true,\n \"sms\": true,\n \"text\": \"<string>\"\n },\n \"submission_id\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"workspace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submission_id": "<string>",
"replayed": true,
"ignored_fields": [
"<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.
128Your key for this write: send the same key when you retry and the first result comes back instead of a second action. Keys are honoured for at least 24 hours. 1–200 visible ASCII characters. Replaces the idempotency_key body field, which still works until 2026-12-31.
200Body
The submitter's email address. Required; the contact is matched on it.
The submitter's name, as they typed it.
200The submitter's phone number; sent to the CRM in international form when it can be read as one.
64Your name for the form on your site (lowercase letters, digits, - or _), e.g. newsletter or demo_request. An automation can start only on leads from one form.
64Every other field the form collected, by its own name, as strings. Stored with the lead as sent.
Show child attributes
Show child attributes
The visit's first-touch campaign tags and click ids, when your site kept them, by their URL names: utm_source, utm_medium, utm_campaign, utm_term, utm_content, fbclid, gclid, li_fat_id. Any other key is dropped and listed in ignored_fields.
Show child attributes
Show child attributes
What the submitter agreed to, recorded with the lead as sent.
Show child attributes
Show child attributes
Optional. An id naming this submission, also accepted as the Idempotency-Key header; with none, the answer's submission_id names it. Send the same value only when retrying the same submission: a retry returns the first answer and stores nothing again.
1 - 200Deprecated on REST: send the Idempotency-Key header instead. Still accepted until 2026-12-31; if both are sent they must match.
1 - 200Which 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.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$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