Raw schema
{
"type": "object",
"properties": {
"max": {
"description": "Max appointments to return (default 100). Paginated output may return fewer to fit the output cap; follow nextOffset.",
"type": "integer",
"minimum": 1,
"maximum": 1000
},
"offset": {
"description": "Zero-based connector offset; enables paginated output. Start at 0, then use pagination.nextOffset with the same filters. At 10,000 rows, narrow the date range.",
"type": "integer",
"minimum": 0,
"maximum": 9999
},
"view": {
"description": "full (default): appointment details. contacts: only id, firstName, lastName, email, phone and datetime, in a compact paginated response; excludes intake forms and notes.",
"type": "string",
"enum": [
"full",
"contacts"
]
},
"excludeForms": {
"description": "Omit forms and formsText, including from full-view results. Automatically true for contacts view. Uses Acuity's excludeForms parameter.",
"type": "boolean"
},
"minDate": {
"description": "Only appointments on/after this date (YYYY-MM-DD or ISO datetime).",
"type": "string"
},
"maxDate": {
"description": "Only appointments on/before this date (YYYY-MM-DD or ISO datetime).",
"type": "string"
},
"calendarID": {
"description": "Filter to a specific calendar id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"appointmentTypeID": {
"description": "Filter to a specific appointment type id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"canceled": {
"description": "If true, return canceled appointments (default false).",
"type": "boolean"
},
"email": {
"description": "Filter by client email.",
"type": "string"
},
"firstName": {
"description": "Filter by client first name.",
"type": "string"
},
"lastName": {
"description": "Filter by client last name.",
"type": "string"
},
"direction": {
"description": "Sort order by datetime. Acuity defaults to DESC; paginated calls use DESC unless specified.",
"type": "string",
"enum": [
"ASC",
"DESC"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}