Skip to content
Website BuddyWebsite BuddyWebsite builder
Sign inGet started
API reference/Design choices

Get a site's design choices

Try it

The site's newest design choices that are waiting or chosen (null when there are none): the link to send your client, each look with a preview address, and — once they've picked — who chose which, when, and their comment.

GET/api/v1/sites/{site_id}/design-choices

Authentication

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_design_choices

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
curl -X GET 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/design-choices' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"
Example arguments
{
  "site_id": "SITE_ID"
}
Response schema
{
  "type": "object",
  "properties": {
    "data": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "site_id": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "OPEN",
                "CHOSEN",
                "WITHDRAWN"
              ]
            },
            "link": {
              "type": "string",
              "description": "The page to send your client (in your brand; your own address when it's connected)."
            },
            "title": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "note": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "options": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "index": {
                    "type": "number"
                  },
                  "style": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "colors": {
                    "anyOf": [
                      {
                        "type": "object",
                        "propertyNames": {
                          "type": "string"
                        },
                        "additionalProperties": {
                          "type": "string"
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "preview_url": {
                    "type": "string"
                  }
                },
                "required": [
                  "index",
                  "style",
                  "name",
                  "description",
                  "colors",
                  "preview_url"
                ],
                "additionalProperties": false
              }
            },
            "chosen": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "index": {
                      "type": "number"
                    },
                    "name": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "email": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "comment": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "at": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "index",
                    "name",
                    "email",
                    "comment",
                    "at"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "null"
                }
              ]
            },
            "created_at": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "site_id",
            "status",
            "link",
            "title",
            "note",
            "options",
            "chosen",
            "created_at"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}