Skip to main content
Glama
Sign In

Checkout Page

by com.checkoutpage
OverviewDiscussionsAdmin

list_events

Read-only

List the event pages on the Checkout Page account, newest first, each with its full configuration, event details, ticket groups, ticket types and fields. Archived events are left out unless you filter by status. Read-only; this is how to find an event id for get_event, update_event, list_bookings and list_tickets. Checkout pages and forms are separate page types: use list_checkout_pages and list_forms.

Input Schema

NameRequiredDescriptionDefault
limitNoNumber of records per page (integer, max 100, default 10).
searchNoCase-insensitive contains match against the event's internal name and title. Searching 'gala' matches an event titled 'Summer gala'. There is no filter by event date, venue or ticket type: page through and inspect `eventDetails` and `ticketGroups` instead.
statusNoFilter by publication status: `published`, `draft` or `archived`. Only one status per call. Without it, published and draft pages are returned and archived pages are excluded, so pass `archived` explicitly to see archived pages.
testmodeNoSet to true to return only pages in test mode, or false for only pages not in test mode.
ending_beforeNoCursor-based pagination. Pass a record `id` to return results before it. Cannot be used with `starting_after`.
starting_afterNoCursor-based pagination. Pass a record `id` to return results after it. Cannot be used with `ending_before`.

Output Schema

NameRequiredDescriptionDefault
dataYes
totalYesTotal number of records matching the query across all pages.
has_moreYesWhether more records exist beyond the current page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedOutput schema / properties / data / items / properties / attendeeQuestions
      Removed value: -{
-  "items": {
-    "$ref": "#/$defs/Field"
-  },
-  "type": "array"
-}
    • changedOutput schema / properties / data / items / properties / eventDetails / anyOf
      Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "attendeeDetails": {
-        "anyOf": [
-          {
-            "additionalProperties": false,
-            "description": "Attendee details settings for this event.",
-            "properties": {
-              "description": {
-                "description": "Text under the heading.",
-                "maxLength": 120,
-                "type": "string"
-              },
-              "emailDomains": {
-                "description": "Which attendee email addresses are accepted. `any` (default): any address. `flag`: any, with personal addresses (Gmail, Outlook and the like) flagged for review. `work`: work addresses only. `workFlag`: work addresses only, with ones outside the booker's company flagged for review. `same`: addresses at the booker's company only.",
-                "enum": [
-                  "any",
-                  "flag",
-                  "work",
-                  "workFlag",
-                  "same"
-                ],
-                "type": "string"
-              },
-              "enabled": {
-                "description": "Collect a name, an email address and the answers to any attendee questions for each ticket. Defaults to `false`.",
-                "type": "boolean"
-              },
-              "enabledAt": {
-                "description": "ISO 8601 timestamp of when attendee details were first switched on. Bookings made before it get no automatic reminders.",
-                "type": "string"
-              },
-              "heading": {
-                "description": "Heading above the attendee rows.",
-                "maxLength": 200,
-                "type": "string"
-              },
-              "requireAllBeforePayment": {
-                "description": "With `when: checkout`, every attendee must be added before the customer can pay. Defaults to `true`.",
-                "type": "boolean"
-              },
-              "saveButton": {
-                "description": "Label of each attendee row's save button.",
-                "maxLength": 40,
-                "type": "string"
-              },
-              "sendReminders": {
-                "description": "Email the booker reminders until every attendee is added. Defaults to `true`.",
-                "type": "boolean"
-              },
-              "when": {
-                "description": "`checkout`: the customer adds attendees before paying. `afterBooking`: they add them after booking, from the confirmation page, their email or the customer portal. Defaults to `checkout`.",
-                "enum": [
-                  "checkout",
-                  "afterBooking"
-                ],
-                "type": "string"
-              }
-            },
-            "type": "object"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "capacity": {
-        "type": [
-          "number",
-          "null"
-        ]
-      },
-      "currency": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "discounts": {
-        "anyOf": [
-          {
-            "items": {
-              "additionalProperties": false,
-              "properties": {
-                "amountOff": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "maxQuantity": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "minQuantity": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "percentOff": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "quantityCondition": {
-                  "anyOf": [
-                    {
-                      "enum": [
-                        "total_quantity",
-                        "ticket_type_quantity"
-                      ],
-                      "type": "string"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                },
-                "ticketTypeIds": {
-                  "anyOf": [
-                    {
-                      "items": {
-                        "pattern": "^[0-9a-fA-F]{24}$",
-                        "type": "string"
-                      },
-                      "type": "array"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                }
-              },
-              "type": "object"
-            },
-            "type": "array"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "endDate": {
-        "anyOf": [
-          {
-            "format": "date-time",
-            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "fixedTaxRateIds": {
-        "anyOf": [
-          {
-            "items": {
-              "type": "string"
-            },
-            "maxItems": 1,
-            "type": "array"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "limitRegistrations": {
-        "anyOf": [
-          {
-            "additionalProperties": false,
-            "properties": {
-              "enabled": {
-                "type": [
-                  "boolean",
-                  "null"
-                ]
-              },
-              "enabledAt": {
-                "type": [
-                  "string",
-                  "null"
-                ]
-              }
-            },
-            "type": "object"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "location": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "mapsLink": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "meetingLink": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "pdfTicketsEnabled": {
-        "type": [
-          "boolean",
-          "null"
-        ]
-      },
-      "platform": {
-        "anyOf": [
-          {
-            "enum": [
-              "zoom",
-              "google_meet",
-              "microsoft_teams",
-              "youtube",
-              "hopin",
-              "vimeo",
-              "discord",
-              "other"
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "startDate": {
-        "anyOf": [
-          {
-            "format": "date-time",
-            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "status": {
-        "anyOf": [
-          {
-            "enum": [
-              "active",
-              "sold_out",
-              "canceled"
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "taxBehavior": {
-        "anyOf": [
-          {
-            "enum": [
-              "inclusive",
-              "exclusive",
-              "automatic",
-              ""
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "taxCode": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "timezone": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "type": {
-        "anyOf": [
-          {
-            "enum": [
-              "in_person",
-              "virtual",
-              "hybrid"
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "capacity": {
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "currency": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "discounts": {
+        "anyOf": [
+          {
+            "items": {
+              "additionalProperties": false,
+              "properties": {
+                "amountOff": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "maxQuantity": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "minQuantity": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "percentOff": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "quantityCondition": {
+                  "anyOf": [
+                    {
+                      "enum": [
+                        "total_quantity",
+                        "ticket_type_quantity"
+                      ],
+                      "type": "string"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "ticketTypeIds": {
+                  "anyOf": [
+                    {
+                      "items": {
+                        "pattern": "^[0-9a-fA-F]{24}$",
+                        "type": "string"
+                      },
+                      "type": "array"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                }
+              },
+              "type": "object"
+            },
+            "type": "array"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "endDate": {
+        "anyOf": [
+          {
+            "format": "date-time",
+            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "fixedTaxRateIds": {
+        "anyOf": [
+          {
+            "items": {
+              "type": "string"
+            },
+            "maxItems": 1,
+            "type": "array"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "limitRegistrations": {
+        "anyOf": [
+          {
+            "additionalProperties": false,
+            "properties": {
+              "enabled": {
+                "type": [
+                  "boolean",
+                  "null"
+                ]
+              },
+              "enabledAt": {
+                "type": [
+                  "string",
+                  "null"
+                ]
+              }
+            },
+            "type": "object"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "location": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "mapsLink": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "meetingLink": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "pdfTicketsEnabled": {
+        "type": [
+          "boolean",
+          "null"
+        ]
+      },
+      "platform": {
+        "anyOf": [
+          {
+            "enum": [
+              "zoom",
+              "google_meet",
+              "microsoft_teams",
+              "youtube",
+              "hopin",
+              "vimeo",
+              "discord",
+              "other"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "startDate": {
+        "anyOf": [
+          {
+            "format": "date-time",
+            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "status": {
+        "anyOf": [
+          {
+            "enum": [
+              "active",
+              "sold_out",
+              "canceled"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "taxBehavior": {
+        "anyOf": [
+          {
+            "enum": [
+              "inclusive",
+              "exclusive",
+              "automatic",
+              ""
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "taxCode": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "timezone": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "type": {
+        "anyOf": [
+          {
+            "enum": [
+              "in_person",
+              "virtual",
+              "hybrid"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
  2. Changed2 schema fields changed
    • addedOutput schema / properties / data / items / properties / attendeeQuestions
      Added value: +{
+  "items": {
+    "$ref": "#/$defs/Field"
+  },
+  "type": "array"
+}
    • changedOutput schema / properties / data / items / properties / eventDetails / anyOf
      Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "capacity": {
-        "type": [
-          "number",
-          "null"
-        ]
-      },
-      "currency": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "discounts": {
-        "anyOf": [
-          {
-            "items": {
-              "additionalProperties": false,
-              "properties": {
-                "amountOff": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "maxQuantity": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "minQuantity": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "percentOff": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "quantityCondition": {
-                  "anyOf": [
-                    {
-                      "enum": [
-                        "total_quantity",
-                        "ticket_type_quantity"
-                      ],
-                      "type": "string"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                },
-                "ticketTypeIds": {
-                  "anyOf": [
-                    {
-                      "items": {
-                        "pattern": "^[0-9a-fA-F]{24}$",
-                        "type": "string"
-                      },
-                      "type": "array"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                }
-              },
-              "type": "object"
-            },
-            "type": "array"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "endDate": {
-        "anyOf": [
-          {
-            "format": "date-time",
-            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "fixedTaxRateIds": {
-        "anyOf": [
-          {
-            "items": {
-              "type": "string"
-            },
-            "maxItems": 1,
-            "type": "array"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "limitRegistrations": {
-        "anyOf": [
-          {
-            "additionalProperties": false,
-            "properties": {
-              "enabled": {
-                "type": [
-                  "boolean",
-                  "null"
-                ]
-              },
-              "enabledAt": {
-                "type": [
-                  "string",
-                  "null"
-                ]
-              }
-            },
-            "type": "object"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "location": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "mapsLink": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "meetingLink": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "pdfTicketsEnabled": {
-        "type": [
-          "boolean",
-          "null"
-        ]
-      },
-      "platform": {
-        "anyOf": [
-          {
-            "enum": [
-              "zoom",
-              "google_meet",
-              "microsoft_teams",
-              "youtube",
-              "hopin",
-              "vimeo",
-              "discord",
-              "other"
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "startDate": {
-        "anyOf": [
-          {
-            "format": "date-time",
-            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "status": {
-        "anyOf": [
-          {
-            "enum": [
-              "active",
-              "sold_out",
-              "canceled"
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "taxBehavior": {
-        "anyOf": [
-          {
-            "enum": [
-              "inclusive",
-              "exclusive",
-              "automatic",
-              ""
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "taxCode": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "timezone": {
-        "type": [
-          "string",
-          "null"
-        ]
-      },
-      "type": {
-        "anyOf": [
-          {
-            "enum": [
-              "in_person",
-              "virtual",
-              "hybrid"
-            ],
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "attendeeDetails": {
+        "anyOf": [
+          {
+            "additionalProperties": false,
+            "description": "Attendee details settings for this event.",
+            "properties": {
+              "description": {
+                "description": "Text under the heading.",
+                "maxLength": 120,
+                "type": "string"
+              },
+              "emailDomains": {
+                "description": "Which attendee email addresses are accepted. `any` (default): any address. `flag`: any, with personal addresses (Gmail, Outlook and the like) flagged for review. `work`: work addresses only. `workFlag`: work addresses only, with ones outside the booker's company flagged for review. `same`: addresses at the booker's company only.",
+                "enum": [
+                  "any",
+                  "flag",
+                  "work",
+                  "workFlag",
+                  "same"
+                ],
+                "type": "string"
+              },
+              "enabled": {
+                "description": "Collect a name, an email address and the answers to any attendee questions for each ticket. Defaults to `false`.",
+                "type": "boolean"
+              },
+              "enabledAt": {
+                "description": "ISO 8601 timestamp of when attendee details were first switched on. Bookings made before it get no automatic reminders.",
+                "type": "string"
+              },
+              "heading": {
+                "description": "Heading above the attendee rows.",
+                "maxLength": 200,
+                "type": "string"
+              },
+              "requireAllBeforePayment": {
+                "description": "With `when: checkout`, every attendee must be added before the customer can pay. Defaults to `true`.",
+                "type": "boolean"
+              },
+              "saveButton": {
+                "description": "Label of each attendee row's save button.",
+                "maxLength": 40,
+                "type": "string"
+              },
+              "sendReminders": {
+                "description": "Email the booker reminders until every attendee is added. Defaults to `true`.",
+                "type": "boolean"
+              },
+              "when": {
+                "description": "`checkout`: the customer adds attendees before paying. `afterBooking`: they add them after booking, from the confirmation page, their email or the customer portal. Defaults to `checkout`.",
+                "enum": [
+                  "checkout",
+                  "afterBooking"
+                ],
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "capacity": {
+        "type": [
+          "number",
+          "null"
+        ]
+      },
+      "currency": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "discounts": {
+        "anyOf": [
+          {
+            "items": {
+              "additionalProperties": false,
+              "properties": {
+                "amountOff": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "maxQuantity": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "minQuantity": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "percentOff": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "quantityCondition": {
+                  "anyOf": [
+                    {
+                      "enum": [
+                        "total_quantity",
+                        "ticket_type_quantity"
+                      ],
+                      "type": "string"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "ticketTypeIds": {
+                  "anyOf": [
+                    {
+                      "items": {
+                        "pattern": "^[0-9a-fA-F]{24}$",
+                        "type": "string"
+                      },
+                      "type": "array"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                }
+              },
+              "type": "object"
+            },
+            "type": "array"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "endDate": {
+        "anyOf": [
+          {
+            "format": "date-time",
+            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "fixedTaxRateIds": {
+        "anyOf": [
+          {
+            "items": {
+              "type": "string"
+            },
+            "maxItems": 1,
+            "type": "array"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "limitRegistrations": {
+        "anyOf": [
+          {
+            "additionalProperties": false,
+            "properties": {
+              "enabled": {
+                "type": [
+                  "boolean",
+                  "null"
+                ]
+              },
+              "enabledAt": {
+                "type": [
+                  "string",
+                  "null"
+                ]
+              }
+            },
+            "type": "object"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "location": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "mapsLink": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "meetingLink": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "pdfTicketsEnabled": {
+        "type": [
+          "boolean",
+          "null"
+        ]
+      },
+      "platform": {
+        "anyOf": [
+          {
+            "enum": [
+              "zoom",
+              "google_meet",
+              "microsoft_teams",
+              "youtube",
+              "hopin",
+              "vimeo",
+              "discord",
+              "other"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "startDate": {
+        "anyOf": [
+          {
+            "format": "date-time",
+            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "status": {
+        "anyOf": [
+          {
+            "enum": [
+              "active",
+              "sold_out",
+              "canceled"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "taxBehavior": {
+        "anyOf": [
+          {
+            "enum": [
+              "inclusive",
+              "exclusive",
+              "automatic",
+              ""
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "taxCode": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "timezone": {
+        "type": [
+          "string",
+          "null"
+        ]
+      },
+      "type": {
+        "anyOf": [
+          {
+            "enum": [
+              "in_person",
+              "virtual",
+              "hybrid"
+            ],
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]
  3. Changed2 schema fields changed
    • addedOutput schema / $defs / FormLayoutDivider / properties / disabled
      Added value: +{
+  "description": "`true` keeps the divider in the layout but hides it from customers. Defaults to `false`.",
+  "type": "boolean"
+}
    • addedOutput schema / $defs / FormLayoutHeading / properties / disabled
      Added value: +{
+  "description": "`true` keeps the heading in the layout but hides it from customers. Defaults to `false`.",
+  "type": "boolean"
+}
  4. Changed2 schema fields changed
    • changedOutput schema / properties / data / items / properties / confirmationCheckoutMessage / description
      Previous value: -"Confirmation page message."New value: +"Confirmation page message. Variables read as `{{id}}` and conditional paragraphs as `<if variable=\"...\" operator=\"...\" value=\"...\">` blocks; send them back unchanged to keep them."
    • changedOutput schema / properties / data / items / properties / confirmationEmailMessage / description
      Previous value: -"Custom confirmation email message."New value: +"Custom confirmation email message. Variables read as `{{id}}` and conditional paragraphs as `<if variable=\"...\" operator=\"...\" value=\"...\">` blocks; send them back unchanged to keep them."
  5. Changed1 schema field changed
    • changedOutput schema / $defs / Field / properties / reference / description
      Previous value: -"External reference ID for mapping this field in downstream systems."New value: +"Stable key that exports, Zapier, Google Sheets and webhooks use for this field's answers. Not updated when the label changes."
  6. Changed8 schema fields changed
    • changedOutput schema / $defs / Field / properties / order / description
      Previous value: -"Display order of the field within the form."New value: +"Position of the field among the page's fields, from 0. `formLayout` on the page decides the form's order. Each field's `order` is its position among the page's fields and follows the layout: saving a layout (in the dashboard or through the API) rewrites every field's `order`. On a page that has never saved a layout, setting `order` moves the field; once a layout is saved, move fields with `formLayout` instead."
    • addedOutput schema / $defs / FormLayoutDiscountCode
      Added value: +{
+  "additionalProperties": false,
+  "description": "Where the discount code box sits. This item only places the box: the box shows while the page has `showCouponCodeField` on. Checkout pages and events only.",
+  "properties": {
+    "type": {
+      "const": "discount-code",
+      "description": "Always `discount-code`.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type"
+  ],
+  "type": "object"
+}
    • addedOutput schema / $defs / FormLayoutDivider
      Added value: +{
+  "additionalProperties": false,
+  "description": "A line that separates parts of the form.",
+  "properties": {
+    "id": {
+      "description": "The divider's id, chosen by you: 1 to 64 characters, unique in the layout.",
+      "maxLength": 64,
+      "minLength": 1,
+      "type": "string"
+    },
+    "type": {
+      "const": "divider",
+      "description": "Always `divider`.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type",
+    "id"
+  ],
+  "type": "object"
+}
    • addedOutput schema / $defs / FormLayoutField
      Added value: +{
+  "additionalProperties": false,
+  "description": "A field on the page, shown where it sits in the layout.",
+  "properties": {
+    "fieldId": {
+      "description": "The `id` of a field in the page's `fields`.",
+      "pattern": "^[0-9a-fA-F]{24}$",
+      "type": "string"
+    },
+    "type": {
+      "const": "field",
+      "description": "Always `field`.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type",
+    "fieldId"
+  ],
+  "type": "object"
+}
    • addedOutput schema / $defs / FormLayoutGroup
      Added value: +{
+  "additionalProperties": false,
+  "description": "Items shown side by side in columns.",
+  "properties": {
+    "columns": {
+      "description": "How many items sit side by side, 1 to 4. On phones the group stacks by default.",
+      "maximum": 4,
+      "minimum": 1,
+      "type": "integer"
+    },
+    "id": {
+      "description": "The group's id, chosen by you: 1 to 64 characters, unique in the layout.",
+      "maxLength": 64,
+      "minLength": 1,
+      "type": "string"
+    },
+    "items": {
+      "description": "What the group holds, filled row by row: fields, headings, dividers and the discount code. Groups never nest.",
+      "items": {
+        "oneOf": [
+          {
+            "$ref": "#/$defs/FormLayoutField"
+          },
+          {
+            "$ref": "#/$defs/FormLayoutHeading"
+          },
+          {
+            "$ref": "#/$defs/FormLayoutDivider"
+          },
+          {
+            "$ref": "#/$defs/FormLayoutDiscountCode"
+          }
+        ]
+      },
+      "maxItems": 200,
+      "type": "array"
+    },
+    "name": {
+      "description": "A name for the group, seen only in the dashboard. Up to 100 characters.",
+      "maxLength": 100,
+      "type": "string"
+    },
+    "type": {
+      "const": "group",
+      "description": "Always `group`.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type",
+    "id",
+    "columns",
+    "items"
+  ],
+  "type": "object"
+}
    • addedOutput schema / $defs / FormLayoutHeading
      Added value: +{
+  "additionalProperties": false,
+  "description": "A heading or subheading shown above the items after it.",
+  "properties": {
+    "id": {
+      "description": "The heading's id, chosen by you: 1 to 64 characters, unique in the layout.",
+      "maxLength": 64,
+      "minLength": 1,
+      "type": "string"
+    },
+    "level": {
+      "description": "`heading` for a section title, `subheading` for a smaller one.",
+      "enum": [
+        "heading",
+        "subheading"
+      ],
+      "type": "string"
+    },
+    "text": {
+      "description": "The text shown, up to 200 characters.",
+      "maxLength": 200,
+      "minLength": 1,
+      "type": "string"
+    },
+    "type": {
+      "const": "heading",
+      "description": "Always `heading`.",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type",
+    "id",
+    "text",
+    "level"
+  ],
+  "type": "object"
+}
    • addedOutput schema / $defs / FormLayoutItem
      Added value: +{
+  "description": "More item types may be added later. When reading a layout, skip any item type you do not recognise. When updating, send every item back as you received it, including those.",
+  "oneOf": [
+    {
+      "$ref": "#/$defs/FormLayoutField"
+    },
+    {
+      "$ref": "#/$defs/FormLayoutHeading"
+    },
+    {
+      "$ref": "#/$defs/FormLayoutDivider"
+    },
+    {
+      "$ref": "#/$defs/FormLayoutDiscountCode"
+    },
+    {
+      "$ref": "#/$defs/FormLayoutGroup"
+    }
+  ]
+}
    • addedOutput schema / properties / data / items / properties / formLayout
      Added value: +{
+  "description": "How the page's form is arranged, top to bottom: fields, headings, dividers, groups of fields shown side by side in columns, and where the discount code box sits. Always returned, even for a page that was never arranged: every field on the page is listed, and `fieldId` matches the `id` of an entry in `fields`. A `discount-code` item only places the box, which shows while `showCouponCodeField` is on. A placement you saved is returned whether the box is on or off; when none was saved and the box is on, the item is at the end, where the box shows. Forms never have one. Each item is one of: `field` (`fieldId`), `heading` (`id`, `text`, `level` `heading` or `subheading`), `divider` (`id`), `discount-code` (no other properties) and `group` (`id`, optional `name`, `columns` 1 to 4, and `items` holding fields, headings, dividers or the discount code; groups never nest). You choose the `id` of each heading, divider and group: 1 to 64 characters, unique in the layout. `formLayout` on the page decides the form's order. Each field's `order` is its position among the page's fields and follows the layout: saving a layout (in the dashboard or through the API) rewrites every field's `order`. On a page that has never saved a layout, setting `order` moves the field; once a layout is saved, move fields with `formLayout` instead. More item types may be added later. When reading a layout, skip any item type you do not recognise. When updating, send every item back as you received it, including those.",
+  "items": {
+    "$ref": "#/$defs/FormLayoutItem"
+  },
+  "type": "array"
+}
  7. Changed1 schema field changed
    • addedOutput schema / $defs / Field / properties / disabled
      Added value: +{
+  "description": "Whether this field is switched off. A disabled field keeps its settings but is removed from the page entirely.",
+  "example": false,
+  "type": [
+    "boolean",
+    "null"
+  ]
+}
  8. Changed2 schema fields changed
    • addedOutput schema / $defs / PageCoverProcessingFees
      Added value: +{
+  "additionalProperties": false,
+  "description": "An option that lets customers choose to cover the processing fee. The contribution is `percentage` of the total plus `amount`, and is not an Additional fee.",
+  "properties": {
+    "amount": {
+      "anyOf": [
+        {
+          "maximum": 9007199254740991,
+          "minimum": -9007199254740991,
+          "type": "integer"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "enabled": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "label": {
+      "anyOf": [
+        {
+          "maxLength": 200,
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "percentage": {
+      "anyOf": [
+        {
+          "maximum": 100,
+          "minimum": 0,
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "preselected": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    },
+    "showAmount": {
+      "type": [
+        "boolean",
+        "null"
+      ]
+    }
+  },
+  "type": "object"
+}
    • addedOutput schema / properties / data / items / properties / coverProcessingFees
      Added value: +{
+  "anyOf": [
+    {
+      "items": {
+        "$ref": "#/$defs/PageCoverProcessingFees"
+      },
+      "type": "array"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Options that let customers choose to cover the processing fee. Empty when the page has none. The list holds at most one option for now."
+}
  9. Changed1 schema field changed
    • changedOutput schema / properties / data / items / properties / ticketGroups / anyOf
      Previous value: -[
-  {
-    "items": {
-      "additionalProperties": false,
-      "properties": {
-        "availabilityBehavior": {
-          "anyOf": [
-            {
-              "enum": [
-                "always_available",
-                "date_time_based",
-                "after_ticket_sale_ends",
-                "after_ticket_sold_out",
-                "after_ticket_ends_or_sold_out",
-                "until_event_starts"
-              ],
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "availabilityStatus": {
-          "anyOf": [
-            {
-              "enum": [
-                "available",
-                "sold_out",
-                "unavailable"
-              ],
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "bulkDiscounts": {
-          "anyOf": [
-            {
-              "items": {
-                "additionalProperties": false,
-                "properties": {
-                  "maxQuantity": {
-                    "type": "number"
-                  },
-                  "minQuantity": {
-                    "type": "number"
-                  },
-                  "percentOff": {
-                    "type": "number"
-                  }
-                },
-                "required": [
-                  "minQuantity",
-                  "maxQuantity",
-                  "percentOff"
-                ],
-                "type": "object"
-              },
-              "type": "array"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "capacity": {
-          "type": [
-            "number",
-            "null"
-          ]
-        },
-        "description": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "feeDisplay": {
-          "anyOf": [
-            {
-              "enum": [
-                "included",
-                "separate"
-              ],
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "hidden": {
-          "type": [
-            "boolean",
-            "null"
-          ]
-        },
-        "hideWhenNotOnSale": {
-          "type": [
-            "boolean",
-            "null"
-          ]
-        },
-        "hideWhenScheduled": {
-          "type": [
-            "boolean",
-            "null"
-          ]
-        },
-        "hideWhenSoldOut": {
-          "type": [
-            "boolean",
-            "null"
-          ]
-        },
-        "hideWhenUnavailable": {
-          "type": [
-            "boolean",
-            "null"
-          ]
-        },
-        "id": {
-          "type": "string"
-        },
-        "layout": {
-          "anyOf": [
-            {
-              "additionalProperties": false,
-              "properties": {
-                "alignment": {
-                  "anyOf": [
-                    {
-                      "enum": [
-                        "default",
-                        "center",
-                        "stack"
-                      ],
-                      "type": "string"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                },
-                "collapse": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "columns": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "imageSize": {
-                  "anyOf": [
-                    {
-                      "enum": [
-                        "small",
-                        "medium",
-                        "large",
-                        ""
-                      ],
-                      "type": "string"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                },
-                "showPwywPlaceholder": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "showTicketFee": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "showTicketGroupName": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "showTicketPrice": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "showTicketSaleDateTimezone": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "showTicketTotalPrice": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "showTicketTypeName": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "spacing": {
-                  "anyOf": [
-                    {
-                      "enum": [
-                        "comfortable",
-                        "compact"
-                      ],
-                      "type": "string"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                },
-                "type": {
-                  "anyOf": [
-                    {
-                      "enum": [
-                        "list",
-                        "grid",
-                        "accordion"
-                      ],
-                      "type": "string"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                }
-              },
-              "type": "object"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "name": {
-          "type": "string"
-        },
-        "preselect": {
-          "anyOf": [
-            {
-              "additionalProperties": false,
-              "properties": {
-                "enabled": {
-                  "type": [
-                    "boolean",
-                    "null"
-                  ]
-                },
-                "quantity": {
-                  "type": [
-                    "number",
-                    "null"
-                  ]
-                },
-                "ticketTypeId": {
-                  "anyOf": [
-                    {
-                      "pattern": "^[0-9a-fA-F]{24}$",
-                      "type": "string"
-                    },
-                    {
-                      "type": "null"
-                    }
-                  ]
-                }
-              },
-              "type": "object"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "reference": {
-          "type": [
-            "string",
-            "null"
-          ]
-        },
-        "saleEndOn": {
-          "anyOf": [
-            {
-              "format": "date-time",
-              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "saleStartOn": {
-          "anyOf": [
-            {
-              "format": "date-time",
-              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "status": {
-          "anyOf": [
-            {
-              "enum": [
-                "enabled",
-                "disabled",
-                "archived"
-              ],
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "ticketSelectionType": {
-          "anyOf": [
-            {
-              "enum": [
-                "single",
-                "multiple",
-                "quantity"
-              ],
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "ticketTypes": {
-          "anyOf": [
-            {
-              "items": {
-                "additionalProperties": false,
-                "properties": {
-                  "availabilityBehavior": {
-                    "anyOf": [
-                      {
-                        "enum": [
-                          "always_available",
-                          "date_time_based",
-                          "after_ticket_sale_ends",
-                          "after_ticket_sold_out",
-                          "after_ticket_ends_or_sold_out",
-                          "until_event_starts"
-                        ],
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
-                  "availabilityStatus": {
-                    "anyOf": [
-                      {
-                        "enum": [
-                          "available",
-                          "sold_out",
-                          "unavailable"
-                        ],
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
-                  "capacity": {
-                    "type": [
-                      "number",
-                      "null"
-                    ]
-                  },
-                  "description": {
-                    "type": [
-                      "string",
-                      "null"
-                    ]
-                  },
-                  "discountedFromPrice": {
-                    "type": [
-                      "number",
-                      "null"
-                    ]
-                  },
-                  "feeAmount": {
-                    "type": [
-                      "number",
-                      "null"
-                    ]
-                  },
-                  "hidden": {
-                    "type": [
-                      "boolean",
-                      "null"
-                    ]
-                  },
-                  "hideWhenNotOnSale": {
-                    "type": [
-                      "boolean",
-                      "null"
-                    ]
-                  },
-                  "hideWhenScheduled": {
-                    "type": [
-                      "boolean",
-                      "null"
-                    ]
-                  },
-                  "hideWhenSoldOut": {
-                    "type": [
-                      "boolean",
-                      "null"
-                    ]
-                  },
-                  "hideWhenUnavailable": {
-                    "type": [
-                      "boolean",
-                      "null"
-                    ]
-                  },
-                  "id": {
-                    "type": "string"
-                  },
-                  "image": {
-                    "anyOf": [
-                      {
-                        "additionalProperties": false,
-                        "properties": {
-                          "fileId": {
-                            "anyOf": [
-                              {
-                                "pattern": "^[0-9a-fA-F]{24}$",
-                                "type": "string"
-                              },
-                              {
-                                "type": "null"
-                              }
-                            ],
-                            "description": "Unique identifier for the uploaded file. Absent for images added by URL (e.g. stock photos).",
-                            "example": "507f1f77bcf86cd799439011"
-                          },
-                          "height": {
-                            "description": "Image height in pixels.",
-                            "example": 1080,
-                            "type": [
-                              "number",
-                              "null"
-                            ]
-                          },
-                          "name": {
-                            "description": "Image file name.",
-                            "example": "product-image.jpg",
-                            "type": "string"
-                          },
-                          "size": {
-                            "description": "File size in bytes.",
-                            "example": 245678,
-                            "type": [
-                              "number",
-                              "null"
-                            ]
-                          },
-                          "url": {
-                            "description": "Image URL.",
-                            "example": "https://bucket-name.s3.amazonaws.com/image.jpg",
-                            "format": "uri",
-                            "type": "string"
-                          },
-                          "width": {
-                            "description": "Image width in pixels.",
-                            "example": 1920,
-                            "type": [
-                              "number",
-                              "null"
-                            ]
-                          }
-                        },
-                        "required": [
-                          "url",
-                          "name"
-                        ],
-                        "type": "object"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
-                  "maxQuantity": {
-                    "type": [
-                      "number",
-                      "null"
-                    ]
-                  },
-                  "minQuantity": {
-                    "type": [
-                      "number",
-                      "null"
-                    ]
-                  },
-                  "name": {
-                    "type": "string"
-                  },
-                  "price": {
-                    "type": [
-                      "number",
-                      "null"
-                    ]
-                  },
-                  "pricing": {
-                    "anyOf": [
-                      {
-                        "enum": [
-                          "paid",
-                          "free",
-                          "pwyw"
-                        ],
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
-                  "pwywSuggestedPrice": {
-                    "type": [
-                      "number",
-                      "null"
-                    ]
-                  },
-                  "quantitySold": {
-                    "type": [
-                      "number",
-                      "null"
-                    ]
-                  },
-                  "reference": {
-                    "type": [
-                      "string",
-                      "null"
-                    ]
-                  },
-                  "saleEndOn": {
-                    "anyOf": [
-                      {
-                        "format": "date-time",
-                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
-                  "saleStartOn": {
-                    "anyOf": [
-                      {
-                        "format": "date-time",
-                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
-                  "showAvailableQuantity": {
-                    "type": [
-                      "boolean",
-                      "null"
-                    ]
-                  },
-                  "showTicketSaleDates": {
-                    "type": [
-                      "boolean",
-                      "null"
-                    ]
-                  },
-                  "status": {
-                    "anyOf": [
-                      {
-                        "enum": [
-                          "enabled",
-                          "disabled",
-                          "archived"
-                        ],
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
-                  "ticketGroupId": {
-                    "anyOf": [
-                      {
-                        "pattern": "^[0-9a-fA-F]{24}$",
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  },
-                  "triggerTicketTypeId": {
-                    "anyOf": [
-                      {
-                        "pattern": "^[0-9a-fA-F]{24}$",
-                        "type": "string"
-                      },
-                      {
-                        "type": "null"
-                      }
-                    ]
-                  }
-                },
-                "required": [
-                  "id",
-                  "name"
-                ],
-                "type": "object"
-              },
-              "type": "array"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        },
-        "triggerTicketGroupId": {
-          "anyOf": [
-            {
-              "pattern": "^[0-9a-fA-F]{24}$",
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ]
-        }
-      },
-      "required": [
-        "id",
-        "name"
-      ],
-      "type": "object"
-    },
-    "type": "array"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "items": {
+      "additionalProperties": false,
+      "properties": {
+        "availabilityBehavior": {
+          "anyOf": [
+            {
+              "enum": [
+                "always_available",
+                "date_time_based",
+                "after_ticket_sale_ends",
+                "after_ticket_sold_out",
+                "after_ticket_ends_or_sold_out",
+                "until_event_starts"
+              ],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "availabilityStatus": {
+          "anyOf": [
+            {
+              "enum": [
+                "available",
+                "sold_out",
+                "unavailable"
+              ],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "bulkDiscounts": {
+          "anyOf": [
+            {
+              "items": {
+                "additionalProperties": false,
+                "properties": {
+                  "maxQuantity": {
+                    "type": "number"
+                  },
+                  "minQuantity": {
+                    "type": "number"
+                  },
+                  "percentOff": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "minQuantity",
+                  "maxQuantity",
+                  "percentOff"
+                ],
+                "type": "object"
+              },
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "capacity": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "description": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "feeDisplay": {
+          "anyOf": [
+            {
+              "enum": [
+                "included",
+                "separate"
+              ],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "hidden": {
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "hideWhenNotOnSale": {
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "hideWhenScheduled": {
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "hideWhenSoldOut": {
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "hideWhenUnavailable": {
+          "type": [
+            "boolean",
+            "null"
+          ]
+        },
+        "id": {
+          "type": "string"
+        },
+        "layout": {
+          "anyOf": [
+            {
+              "additionalProperties": false,
+              "properties": {
+                "alignment": {
+                  "anyOf": [
+                    {
+                      "enum": [
+                        "default",
+                        "center",
+                        "stack"
+                      ],
+                      "type": "string"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "collapse": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "columns": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "imageSize": {
+                  "anyOf": [
+                    {
+                      "enum": [
+                        "small",
+                        "medium",
+                        "large",
+                        ""
+                      ],
+                      "type": "string"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "showPwywPlaceholder": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "showTicketFee": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "showTicketGroupName": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "showTicketPrice": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "showTicketSaleDateTimezone": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "showTicketTotalPrice": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "showTicketTypeName": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "spacing": {
+                  "anyOf": [
+                    {
+                      "enum": [
+                        "comfortable",
+                        "compact"
+                      ],
+                      "type": "string"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                },
+                "type": {
+                  "anyOf": [
+                    {
+                      "enum": [
+                        "list",
+                        "grid",
+                        "accordion"
+                      ],
+                      "type": "string"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                }
+              },
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "name": {
+          "type": "string"
+        },
+        "preselect": {
+          "anyOf": [
+            {
+              "additionalProperties": false,
+              "properties": {
+                "enabled": {
+                  "type": [
+                    "boolean",
+                    "null"
+                  ]
+                },
+                "quantity": {
+                  "type": [
+                    "number",
+                    "null"
+                  ]
+                },
+                "ticketTypeId": {
+                  "anyOf": [
+                    {
+                      "pattern": "^[0-9a-fA-F]{24}$",
+                      "type": "string"
+                    },
+                    {
+                      "type": "null"
+                    }
+                  ]
+                }
+              },
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "reference": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "saleEndOn": {
+          "anyOf": [
+            {
+              "format": "date-time",
+              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "saleStartOn": {
+          "anyOf": [
+            {
+              "format": "date-time",
+              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "status": {
+          "anyOf": [
+            {
+              "enum": [
+                "enabled",
+                "disabled",
+                "archived"
+              ],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "ticketSelectionType": {
+          "anyOf": [
+            {
+              "enum": [
+                "single",
+                "multiple",
+                "quantity"
+              ],
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "ticketTypes": {
+          "anyOf": [
+            {
+              "items": {
+                "additionalProperties": false,
+                "properties": {
+                  "availabilityBehavior": {
+                    "anyOf": [
+                      {
+                        "enum": [
+                          "always_available",
+                          "date_time_based",
+                          "after_ticket_sale_ends",
+                          "after_ticket_sold_out",
+                          "after_ticket_ends_or_sold_out",
+                          "until_event_starts"
+                        ],
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "availabilityStatus": {
+                    "anyOf": [
+                      {
+                        "enum": [
+                          "available",
+                          "sold_out",
+                          "unavailable"
+                        ],
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "capacity": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "description": {
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "discountedFromPrice": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "feeAmount": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "hidden": {
+                    "type": [
+                      "boolean",
+                      "null"
+                    ]
+                  },
+                  "hideWhenNotOnSale": {
+                    "type": [
+                      "boolean",
+                      "null"
+                    ]
+                  },
+                  "hideWhenScheduled": {
+                    "type": [
+                      "boolean",
+                      "null"
+                    ]
+                  },
+                  "hideWhenSoldOut": {
+                    "type": [
+                      "boolean",
+                      "null"
+                    ]
+                  },
+                  "hideWhenUnavailable": {
+                    "type": [
+                      "boolean",
+                      "null"
+                    ]
+                  },
+                  "id": {
+                    "type": "string"
+                  },
+                  "image": {
+                    "anyOf": [
+                      {
+                        "additionalProperties": false,
+                        "properties": {
+                          "fileId": {
+                            "anyOf": [
+                              {
+                                "pattern": "^[0-9a-fA-F]{24}$",
+                                "type": "string"
+                              },
+                              {
+                                "type": "null"
+                              }
+                            ],
+                            "description": "Unique identifier for the uploaded file. Absent for images added by URL (e.g. stock photos).",
+                            "example": "507f1f77bcf86cd799439011"
+                          },
+                          "height": {
+                            "description": "Image height in pixels.",
+                            "example": 1080,
+                            "type": [
+                              "number",
+                              "null"
+                            ]
+                          },
+                          "name": {
+                            "description": "Image file name.",
+                            "example": "product-image.jpg",
+                            "type": "string"
+                          },
+                          "size": {
+                            "description": "File size in bytes.",
+                            "example": 245678,
+                            "type": [
+                              "number",
+                              "null"
+                            ]
+                          },
+                          "url": {
+                            "description": "Image URL.",
+                            "example": "https://bucket-name.s3.amazonaws.com/image.jpg",
+                            "format": "uri",
+                            "type": "string"
+                          },
+                          "width": {
+                            "description": "Image width in pixels.",
+                            "example": 1920,
+                            "type": [
+                              "number",
+                              "null"
+                            ]
+                          }
+                        },
+                        "required": [
+                          "url",
+                          "name"
+                        ],
+                        "type": "object"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "maxQuantity": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "minQuantity": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "price": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "pricing": {
+                    "anyOf": [
+                      {
+                        "enum": [
+                          "paid",
+                          "free",
+                          "pwyw"
+                        ],
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "pwywSuggestedPrice": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "quantitySold": {
+                    "type": [
+                      "number",
+                      "null"
+                    ]
+                  },
+                  "reference": {
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "saleEndOn": {
+                    "anyOf": [
+                      {
+                        "format": "date-time",
+                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "saleStartOn": {
+                    "anyOf": [
+                      {
+                        "format": "date-time",
+                        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "showAvailableQuantity": {
+                    "type": [
+                      "boolean",
+                      "null"
+                    ]
+                  },
+                  "showHideLogic": {
+                    "anyOf": [
+                      {
+                        "additionalProperties": false,
+                        "properties": {
+                          "comparison": {
+                            "enum": [
+                              "is",
+                              "is_not"
+                            ],
+                            "type": "string"
+                          },
+                          "enabled": {
+                            "type": "boolean"
+                          },
+                          "ticketTypeIds": {
+                            "items": {
+                              "type": "string"
+                            },
+                            "type": "array"
+                          }
+                        },
+                        "required": [
+                          "enabled",
+                          "comparison",
+                          "ticketTypeIds"
+                        ],
+                        "type": "object"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "showTicketSaleDates": {
+                    "type": [
+                      "boolean",
+                      "null"
+                    ]
+                  },
+                  "status": {
+                    "anyOf": [
+                      {
+                        "enum": [
+                          "enabled",
+                          "disabled",
+                          "archived"
+                        ],
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "ticketGroupId": {
+                    "anyOf": [
+                      {
+                        "pattern": "^[0-9a-fA-F]{24}$",
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  },
+                  "triggerTicketTypeId": {
+                    "anyOf": [
+                      {
+                        "pattern": "^[0-9a-fA-F]{24}$",
+                        "type": "string"
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  }
+                },
+                "required": [
+                  "id",
+                  "name"
+                ],
+                "type": "object"
+              },
+              "type": "array"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "triggerTicketGroupId": {
+          "anyOf": [
+            {
+              "pattern": "^[0-9a-fA-F]{24}$",
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "name"
+      ],
+      "type": "object"
+    },
+    "type": "array"
+  },
+  {
+    "type": "null"
+  }
+]
  10. First observed

TDQS

A4.7/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered; the description still adds real behavior: default ordering (newest first), default exclusion of archived events unless status is passed, and the fact that full event config/ticket groups are returned. It does not mention pagination limits or response size, so it falls short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, each carrying unique information: what is listed, the archived default, and the id-lookup/alternative routing. Front-loaded with the primary purpose and zero filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so the description needn't enumerate return fields; it still summarizes that records include configuration, event details, ticket groups, ticket types and fields. Combined with the archived-default and pagination-adjacent guidance, nothing essential is missing for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description adds meaning beyond the schema by clarifying that archived events are hidden unless you filter by status, which reinforces the status parameter's effect. It does not touch search, testmode or cursor params, but the schema documents those well, so a 4 is fair.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List the event pages on the Checkout Page account') plus scope details: newest first, full configuration included, archived excluded. It explicitly distinguishes the resource from sibling page types ('Checkout pages and forms are separate page types'), so an agent can tell it apart from list_checkout_pages and list_forms without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete when-to-use routing: 'this is how to find an event id for get_event, update_event, list_bookings and list_tickets.' It also names the two alternatives it is not (list_checkout_pages, list_forms), leaving nothing to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Checkout Page toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources