API reference/Sites
Get a site's settings
Try itThe site's DRAFT site-wide settings: the phone (and the number a tap on Call dials), address and map search, the two logos, the header search button, the announcement strip and the pop-up — each with whether it is showing today.
GET
/api/v1/sites/{site_id}/settingsAuthentication
An API key as Authorization: Bearer or x-api-key. It needs the sites:read scope — read sites, pages and sections.
sites:readRead onlyMCP tool: get_site_settings
Parameters
Named placeholders go in the path; the rest in the query string.
site_idstringPath · required- The site's id.1 to 100 characters
Response
200 with JSON on success (schema on the right). Errors use the standard envelope.
curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/settings' \
-H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"{
"site_id": "SITE_ID"
}{
"type": "object",
"properties": {
"site_id": {
"type": "string"
},
"business_name": {
"type": "string"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"phone_dials": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The number a visitor's phone dials when they tap Call (keypad letters mapped, +1 for US numbers)."
},
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"map_search": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "What every map and directions link searches for instead of the address (a place name + address, or lat,lng)."
},
"logo_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"logo_dark_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The logo for dark backgrounds — the dark footer, dark designs, over photos."
},
"header_search": {
"type": "boolean",
"description": "A search button in the header (the site's /search page)."
},
"announcement": {
"type": "object",
"properties": {
"on": {
"type": "boolean"
},
"text": {
"type": "string"
},
"link_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"link_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The site's own day, YYYY-MM-DD; null = from now."
},
"end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Last day shown (included); null = until switched off."
},
"state": {
"type": "string",
"enum": [
"off",
"showing",
"scheduled",
"ended"
],
"description": "On the draft, today in the site's time zone."
}
},
"required": [
"on",
"text",
"link_label",
"link_url",
"start_date",
"end_date",
"state"
],
"additionalProperties": false
},
"popup": {
"type": "object",
"properties": {
"on": {
"type": "boolean"
},
"kind": {
"type": "string",
"enum": [
"notice",
"sale",
"newsletter"
]
},
"heading": {
"type": "string"
},
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"offer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"button_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"button_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"delay_seconds": {
"type": "number"
},
"start_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"end_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"type": "string",
"enum": [
"off",
"showing",
"scheduled",
"ended"
]
}
},
"required": [
"on",
"kind",
"heading",
"body",
"offer",
"button_label",
"button_url",
"image_url",
"delay_seconds",
"start_date",
"end_date",
"state"
],
"additionalProperties": false
}
},
"required": [
"site_id",
"business_name",
"phone",
"phone_dials",
"address",
"map_search",
"logo_url",
"logo_dark_url",
"header_search",
"announcement",
"popup"
],
"additionalProperties": false
}