List a site's forms

The site's forms with their fields and how many messages (and unread ones) each has. Spam is not counted.

GET/api/v1/sites/{site_id}/forms

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the forms:read scope — read forms and the messages visitors send.

forms:readRead onlyMCP tool: list_forms

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/forms' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "site_id": "SITE_ID"
}

Response schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "kind": {
                  "type": "string",
                  "enum": [
                    "text",
                    "email",
                    "phone",
                    "textarea",
                    "select",
                    "checkbox",
                    "date",
                    "file"
                  ]
                },
                "required": {
                  "type": "boolean"
                },
                "options": {
                  "anyOf": [
                    {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "show_when": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "field_id": {
                          "type": "string"
                        },
                        "is": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      },
                      "required": [
                        "field_id",
                        "is"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "id",
                "label",
                "kind",
                "required",
                "options",
                "show_when"
              ],
              "additionalProperties": false
            }
          },
          "success_message": {
            "type": "string"
          },
          "notify_emails": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "confirmation": {
            "type": "object",
            "properties": {
              "on": {
                "type": "boolean"
              },
              "subject": {
                "type": "string"
              },
              "words": {
                "type": "string"
              },
              "include_answers": {
                "type": "boolean"
              }
            },
            "required": [
              "on",
              "subject",
              "words",
              "include_answers"
            ],
            "additionalProperties": false
          },
          "message_count": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "unread_count": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "is_sample": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "name",
          "fields",
          "success_message",
          "notify_emails",
          "confirmation",
          "message_count",
          "unread_count",
          "is_sample"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}