Servers Playground How we check Add a server Log in

Appointedd MCP by usefulapi

Working · 784 ms

io.usefulapi/appointeddv1.0.0 Domain verified

Read Appointedd bookings, customers and availability; create, change and cancel bookings.

Local Services

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://appointedd.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

appointedd_cancel_booking Destructive

WRITE (cannot be undone): cancel a whole booking. Appointedd may notify the customers according to the organisation's settings. To remove one customer from a group booking use appointedd_cancel_booking_customer. POST /bookings/{booking_id}/cancel.

booking_idstring, required

Appointedd id (24-character hex string).

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Appointedd MCP by usefulapi MCP server | mcptry

Tools (20)

appointedd_cancel_booking

destructive

Argument	Type	Description
booking_id*	string	Appointedd id (24-character hex string).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "booking_id"
  ],
  "properties": {
    "booking_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    }
  }
}

appointedd_cancel_booking_customer

WRITE (cannot be undone): cancel one customer's place on a booking (the booking stays for the others). customer_booking_id is the `customer_booking_id` in the booking's customers list. POST /bookings/{booking_id}/customers/{customer_booking_id}/cancel.

destructive

Argument	Type	Description
booking_id*	string	Appointedd id (24-character hex string).
customer_booking_id*	string	`customer_booking_id` from the booking's customers list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "booking_id",
    "customer_booking_id"
  ],
  "properties": {
    "booking_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    },
    "customer_booking_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "`customer_booking_id` from the booking's customers list."
    }
  }
}

appointedd_create_booking

WRITE: turn an active reservation into a booking (step 3) for one or more customers; Appointedd matches each customer to the CRM by name/email/mobile or creates it. Payment requests are NOT sent unless send_payment_request is true. With an empty customers list an empty booking is created. POST /bookings.

Argument	Type	Description
label	string	Label shown on the booking in the appointment screen.
timezone	string	IANA time zone for the dates and times in the reply, e.g. Europe/London (default UTC).
customers*	array	Customers to add; [] for an empty booking.
reservation_id*	string	Id returned by appointedd_create_reservation (must not have expired).
send_payment_request	boolean	Send each customer a payment request (default false here; the API's own default is true).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "reservation_id",
    "customers"
  ],
  "properties": {
    "label": {
      "type": "string",
      "maxLength": 500,
      "description": "Label shown on the booking in the appointment screen."
    },
    "timezone": {
      "type": "string",
      "description": "IANA time zone for the dates and times in the reply, e.g. Europe/London (default UTC)."
    },
    "customers": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "profile"
        ],
        "properties": {
          "notes": {
            "type": "string",
            "maxLength": 5000,
            "description": "Free-form notes for this customer on the booking."
          },
          "status": {
            "enum": [
              "Arrived",
              "Complete",
              "No Show",
              "No Status"
            ],
            "type": "string"
          },
          "profile": {
            "type": "object",
            "required": [
              "firstname",
              "lastname"
            ],
            "properties": {
              "email": {
                "type": "string",
                "maxLength": 320
              },
              "mobile": {
                "type": "string",
                "maxLength": 40
              },
              "lastname": {
                "type": "string",
                "maxLength": 200,
                "minLength": 1,
                "description": "Last name."
              },
              "firstname": {
                "type": "string",
                "maxLength": 200,
                "minLength": 1,
                "description": "First name."
              }
            }
          },
          "total_spaces": {
            "type": "integer",
            "maximum": 1000,
            "minimum": 1,
            "description": "Spaces this customer uses (default 1)."
          },
          "marketing_subscribed": {
            "type": "boolean",
            "description": "Customer agreed to marketing emails (default false)."
          }
        }
      },
      "maxItems": 50,
      "description": "Customers to add; [] for an empty booking."
    },
    "reservation_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Id returned by appointedd_create_reservation (must not have expired)."
    },
    "send_payment_request": {
      "type": "boolean",
      "description": "Send each customer a payment request (default false here; the API's own default is true)."
    }
  }
}

appointedd_create_customer

WRITE: create a customer in the CRM (first and last name required; email, mobile, phone, tags optional). POST /customers.

Argument	Type	Description
tags	array	Tags to put on the customer.
email	string
phone	string
mobile	string
lastname*	string	Last name.
firstname*	string	First name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "firstname",
    "lastname"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100
      },
      "maxItems": 50,
      "description": "Tags to put on the customer."
    },
    "email": {
      "type": "string",
      "maxLength": 320
    },
    "phone": {
      "type": "string",
      "maxLength": 40
    },
    "mobile": {
      "type": "string",
      "maxLength": 40
    },
    "lastname": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Last name."
    },
    "firstname": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "First name."
    }
  }
}

appointedd_create_reservation

WRITE: hold a date and time for a booking (step 2). The reservation blocks that slot for `expires_after` minutes (default: the organisation's setting); then call appointedd_create_booking with the returned reservation id. Without resource_id a free resource assigned to the service is picked. POST /availability/slots.

Argument	Type	Description
start*	string	Start date-time, normally a `start` returned by appointedd_find_available_intervals.
duration	integer	Booking length in minutes; pass the same `duration` you searched with. Default: the service's default duration.
timezone	string	IANA time zone of `start` (when it has no offset) and of the reply. Default UTC.
service_id*	string	Appointedd id (24-character hex string).
resource_id	string	Resource to book. Default: any free resource of the service.
expires_after	integer	Minutes until the hold expires.
required_spaces	integer	Spaces needed (default 1).
resource_group_ids	array

appointedd_find_available_dates

Find which days in the given ranges have any availability for a service (a calendar view; use appointedd_find_available_intervals for the times). Read-only. POST /availability/days/search.

read-only

Argument	Type	Description
ranges*	array	One or more date-time ranges to search, e.g. [{start, end}].
spaces	integer	Spaces needed (excludes group bookings with too few spaces). Default 1.
duration	integer	Continuous minutes that must be free. Default: the service's default duration.
timezone	string	IANA time zone for range times without an offset and for the reply. Default UTC.
service_id*	string	Service the booking would be for (use appointedd_list_services).
resource_ids	array	Resources (staff, rooms) to check. Default: all resources assigned to the service. Not together with resource_group_ids.
resource_group_ids	array	Resource groups whose resources to check. Not together with resource_ids.

appointedd_find_available_intervals

Find the start times at which a service can be booked in the given ranges, with the free resource ids for each (and existing group bookings with room). Step 1 of making a booking: pick a start, then appointedd_create_reservation. Read-only. POST /availability/intervals/search.

read-only

Argument	Type	Description
ranges*	array	One or more date-time ranges to search, e.g. [{start, end}].
spaces	integer	Spaces needed (excludes group bookings with too few spaces). Default 1.
duration	integer	Continuous minutes that must be free. Default: the service's default duration.
timezone	string	IANA time zone for range times without an offset and for the reply. Default UTC.
service_id*	string	Service the booking would be for (use appointedd_list_services).
resource_ids	array	Resources (staff, rooms) to check. Default: all resources assigned to the service. Not together with resource_group_ids.
resource_group_ids	array	Resource groups whose resources to check. Not together with resource_ids.

appointedd_get_customer

One customer by id. GET /customers/{customer_id}.

read-only

Argument	Type	Description
customer_id*	string	Appointedd id (24-character hex string).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    }
  }
}

appointedd_get_reservation

One reservation (availability slot) by id: its service, resource, times and expiry. GET /availability/slots/{reservation_id}.

read-only

Argument	Type	Description
timezone	string	IANA time zone for the dates and times in the reply, e.g. Europe/London (default UTC).
reservation_id*	string	Appointedd id (24-character hex string).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "reservation_id"
  ],
  "properties": {
    "timezone": {
      "type": "string",
      "description": "IANA time zone for the dates and times in the reply, e.g. Europe/London (default UTC)."
    },
    "reservation_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    }
  }
}

appointedd_get_service

One service by id, including its booking questions, durations, prices and buffers. GET /services/{service_id}.

read-only

Argument	Type	Description
service_id*	string	Appointedd id (24-character hex string).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "service_id"
  ],
  "properties": {
    "service_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    }
  }
}

appointedd_get_service_category

One service category by id. GET /services/categories/{category_id}.

read-only

Argument	Type	Description
category_id*	string	Appointedd id (24-character hex string).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "category_id"
  ],
  "properties": {
    "category_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    }
  }
}

appointedd_list_bookings

List bookings, newest first by default. Filter by time window (after/before), customer, service, resource, category, status or creation/update time. Each booking has its service, resource, start/end, status and the customers on it (with their notes, questions and statuses). Page with `next`. GET /bookings.

read-only

Argument	Type	Description
end	string	Page cursor: pass the previous reply's `prev` to get the preceding page.
ids	array	Only bookings with one of these ids.
after	string	Only bookings that start at or after this date-time.
limit	integer	Results per page, 1-100 (default 25).
start	string	Page cursor: pass the previous reply's `next` to get the following page.
before	string	Only bookings that end at or before this date-time.
sort_by	string	Sort property (default natural).
order_by	string	Sort direction (the API default is desc).

appointedd_list_customers

List customers in the CRM: name, email, phone/mobile, address, tags, custom fields, marketing opt-in. Page with `next`. GET /customers.

read-only

Argument	Type	Description
end	string	Page cursor: pass the previous reply's `prev` to get the preceding page.
ids	array	Only customers with one of these ids.
limit	integer	Results per page, 1-100 (default 25).
start	string	Page cursor: pass the previous reply's `next` to get the following page.
sort_by	string	Sort property (default natural).
order_by	string	Sort direction (the API default is desc).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `prev` to get the preceding page."
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only customers with one of these ids."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "start": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `next` to get the following page."
    },
    "sort_by": {
      "enum": [
        "natural",
        "created",
        "profile.firstname",
        "profile.lastname"
      ],
      "type": "string",
      "description": "Sort property (default natural)."
    },
    "order_by": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction (the API default is desc)."
    }
  }
}

appointedd_list_resource_groups

List resource groups (id and name). Page with `next`. GET /resources/groups.

read-only

Argument	Type	Description
end	string	Page cursor: pass the previous reply's `prev` to get the preceding page.
ids	array	Only resource groups with one of these ids.
limit	integer	Results per page, 1-100 (default 25).
start	string	Page cursor: pass the previous reply's `next` to get the following page.
order_by	string	Sort direction (the API default is desc).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `prev` to get the preceding page."
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only resource groups with one of these ids."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "start": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `next` to get the following page."
    },
    "order_by": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction (the API default is desc)."
    }
  }
}

appointedd_list_resources

List resources (the staff members, rooms or equipment that bookings are made for): name, assigned service ids and resource group ids. Page with `next`. GET /resources.

read-only

Argument	Type	Description
end	string	Page cursor: pass the previous reply's `prev` to get the preceding page.
ids	array	Only resources with one of these ids.
limit	integer	Results per page, 1-100 (default 25).
start	string	Page cursor: pass the previous reply's `next` to get the following page.
sort_by	string
order_by	string	Sort direction (the API default is desc).
services	array	Only resources assigned to services with one of these ids.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `prev` to get the preceding page."
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only resources with one of these ids."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "start": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `next` to get the following page."
    },
    "sort_by": {
      "enum": [
        "natural",
        "creation"
      ],
      "type": "string"
    },
    "order_by": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction (the API default is desc)."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only resources assigned to services with one of these ids."
    }
  }
}

appointedd_list_service_categories

List service categories (id and name). Page with `next`. GET /services/categories.

read-only

Argument	Type	Description
end	string	Page cursor: pass the previous reply's `prev` to get the preceding page.
ids	array	Only service categories with one of these ids.
limit	integer	Results per page, 1-100 (default 25).
start	string	Page cursor: pass the previous reply's `next` to get the following page.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `prev` to get the preceding page."
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only service categories with one of these ids."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "start": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `next` to get the following page."
    }
  }
}

appointedd_list_services

List services (what can be booked): name, category, durations and prices, buffers, occupancy and booking type. Page with `next`. GET /services.

read-only

Argument	Type	Description
end	string	Page cursor: pass the previous reply's `prev` to get the preceding page.
ids	array	Only services with one of these ids.
limit	integer	Results per page, 1-100 (default 25).
start	string	Page cursor: pass the previous reply's `next` to get the following page.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `prev` to get the preceding page."
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only services with one of these ids."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "start": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `next` to get the following page."
    }
  }
}

appointedd_update_booking

WRITE: change a booking's service, resource, label or total spaces, or move it by giving `parts` with new start/end times. Customers are NOT emailed unless send_notifications is true. PUT /bookings/{booking_id}.

destructive

Argument	Type	Description
label	string
parts	array	New time parts of the booking (start/end); an availability check runs when moving.
timezone	string	IANA time zone for the dates and times in the reply, e.g. Europe/London (default UTC).
booking_id*	string	Appointedd id (24-character hex string).
service_id	string	Move the booking to this service.
resource_id	string	Assign the booking to this resource.
total_spaces	integer
send_notifications	boolean	Email each customer that the booking changed (default false here; the API's own default is true).

appointedd_update_booking_customer

WRITE: set the arrival status (Arrived, Complete, No Show, No Status) and/or notes of one customer on a booking. customer_booking_id is the customer's `customer_booking_id` (or `customer_id`) in the booking's customers list. PUT /bookings/{booking_id}/customers/{customer_booking_id}.

destructive

Argument	Type	Description
notes	string	Replaces the customer's notes on this booking.
status	string
booking_id*	string	Appointedd id (24-character hex string).
customer_booking_id*	string	`customer_booking_id` (or `customer_id`) from the booking's customers list.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "booking_id",
    "customer_booking_id"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "maxLength": 5000,
      "description": "Replaces the customer's notes on this booking."
    },
    "status": {
      "enum": [
        "Arrived",
        "Complete",
        "No Show",
        "No Status"
      ],
      "type": "string"
    },
    "booking_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    },
    "customer_booking_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "`customer_booking_id` (or `customer_id`) from the booking's customers list."
    }
  }
}

appointedd_update_customer

WRITE: change a customer's name, email, mobile, phone or tags. Only the fields you pass are sent; `tags` replaces the customer's tag list. PUT /customers/{customer_id}.

destructive

Argument	Type	Description
tags	array	New tag list (replaces the old one).
email	string
phone	string
mobile	string
lastname	string
firstname	string
customer_id*	string	Appointedd id (24-character hex string).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100
      },
      "maxItems": 50,
      "description": "New tag list (replaces the old one)."
    },
    "email": {
      "type": "string",
      "maxLength": 320
    },
    "phone": {
      "type": "string",
      "maxLength": 40
    },
    "mobile": {
      "type": "string",
      "maxLength": 40
    },
    "lastname": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "firstname": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "customer_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ranges",
    "service_id"
  ],
  "properties": {
    "ranges": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "start",
          "end"
        ],
        "properties": {
          "end": {
            "type": "string",
            "description": "ISO 8601 date-time, e.g. 2026-11-02T09:00:00Z (a date-time without an offset is read in UTC unless a timezone is given)."
          },
          "start": {
            "type": "string",
            "description": "ISO 8601 date-time, e.g. 2026-11-02T09:00:00Z (a date-time without an offset is read in UTC unless a timezone is given)."
          }
        }
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "One or more date-time ranges to search, e.g. [{start, end}]."
    },
    "spaces": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Spaces needed (excludes group bookings with too few spaces). Default 1."
    },
    "duration": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Continuous minutes that must be free. Default: the service's default duration."
    },
    "timezone": {
      "type": "string",
      "description": "IANA time zone for range times without an offset and for the reply. Default UTC."
    },
    "service_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Service the booking would be for (use appointedd_list_services)."
    },
    "resource_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1,
        "description": "Appointedd id (24-character hex string)."
      },
      "maxItems": 100,
      "description": "Resources (staff, rooms) to check. Default: all resources assigned to the service. Not together with resource_group_ids."
    },
    "resource_group_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1,
        "description": "Appointedd id (24-character hex string)."
      },
      "maxItems": 100,
      "description": "Resource groups whose resources to check. Not together with resource_ids."
    },
    "ignore_service_schedule": {
      "type": "boolean",
      "description": "Ignore the service's schedule."
    },
    "ignore_notice_restriction": {
      "type": "boolean",
      "description": "Ignore the organisation's/service's notice period."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ranges",
    "service_id"
  ],
  "properties": {
    "ranges": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "start",
          "end"
        ],
        "properties": {
          "end": {
            "type": "string",
            "description": "ISO 8601 date-time, e.g. 2026-11-02T09:00:00Z (a date-time without an offset is read in UTC unless a timezone is given)."
          },
          "start": {
            "type": "string",
            "description": "ISO 8601 date-time, e.g. 2026-11-02T09:00:00Z (a date-time without an offset is read in UTC unless a timezone is given)."
          }
        }
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "One or more date-time ranges to search, e.g. [{start, end}]."
    },
    "spaces": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Spaces needed (excludes group bookings with too few spaces). Default 1."
    },
    "duration": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Continuous minutes that must be free. Default: the service's default duration."
    },
    "timezone": {
      "type": "string",
      "description": "IANA time zone for range times without an offset and for the reply. Default UTC."
    },
    "service_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Service the booking would be for (use appointedd_list_services)."
    },
    "resource_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1,
        "description": "Appointedd id (24-character hex string)."
      },
      "maxItems": 100,
      "description": "Resources (staff, rooms) to check. Default: all resources assigned to the service. Not together with resource_group_ids."
    },
    "resource_group_ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1,
        "description": "Appointedd id (24-character hex string)."
      },
      "maxItems": 100,
      "description": "Resource groups whose resources to check. Not together with resource_ids."
    },
    "ignore_service_schedule": {
      "type": "boolean",
      "description": "Ignore the service's schedule."
    },
    "ignore_notice_restriction": {
      "type": "boolean",
      "description": "Ignore the organisation's/service's notice period."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "end": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `prev` to get the preceding page."
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only bookings with one of these ids."
    },
    "after": {
      "type": "string",
      "description": "Only bookings that start at or after this date-time."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Results per page, 1-100 (default 25)."
    },
    "start": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Page cursor: pass the previous reply's `next` to get the following page."
    },
    "before": {
      "type": "string",
      "description": "Only bookings that end at or before this date-time."
    },
    "sort_by": {
      "enum": [
        "natural",
        "creation",
        "updated",
        "start"
      ],
      "type": "string",
      "description": "Sort property (default natural)."
    },
    "order_by": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction (the API default is desc)."
    },
    "services": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only bookings of services with one of these ids."
    },
    "statuses": {
      "type": "array",
      "items": {
        "enum": [
          "confirmed",
          "declined",
          "cancelled",
          "pending"
        ],
        "type": "string"
      },
      "maxItems": 4,
      "description": "Only bookings with one of these statuses."
    },
    "timezone": {
      "type": "string",
      "description": "IANA time zone for the dates and times in the reply, e.g. Europe/London (default UTC)."
    },
    "customers": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only bookings for customers with one of these ids."
    },
    "resources": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only bookings of resources with one of these ids."
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 100,
      "description": "Only bookings of service categories with one of these ids."
    },
    "created_after": {
      "type": "string",
      "description": "ISO 8601 date-time, e.g. 2026-11-02T09:00:00Z (a date-time without an offset is read in UTC unless a timezone is given)."
    },
    "updated_after": {
      "type": "string",
      "description": "ISO 8601 date-time, e.g. 2026-11-02T09:00:00Z (a date-time without an offset is read in UTC unless a timezone is given)."
    },
    "created_before": {
      "type": "string",
      "description": "ISO 8601 date-time, e.g. 2026-11-02T09:00:00Z (a date-time without an offset is read in UTC unless a timezone is given)."
    },
    "updated_before": {
      "type": "string",
      "description": "ISO 8601 date-time, e.g. 2026-11-02T09:00:00Z (a date-time without an offset is read in UTC unless a timezone is given)."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "booking_id"
  ],
  "properties": {
    "label": {
      "type": "string",
      "maxLength": 500
    },
    "parts": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "start",
          "end"
        ],
        "properties": {
          "end": {
            "type": "string",
            "description": "ISO 8601 date-time with an offset, e.g. 2026-11-02T09:00:00Z."
          },
          "label": {
            "type": "string",
            "maxLength": 200
          },
          "start": {
            "type": "string",
            "description": "ISO 8601 date-time with an offset, e.g. 2026-11-02T09:00:00Z."
          }
        }
      },
      "maxItems": 20,
      "minItems": 1,
      "description": "New time parts of the booking (start/end); an availability check runs when moving."
    },
    "timezone": {
      "type": "string",
      "description": "IANA time zone for the dates and times in the reply, e.g. Europe/London (default UTC)."
    },
    "booking_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Appointedd id (24-character hex string)."
    },
    "service_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Move the booking to this service."
    },
    "resource_id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Assign the booking to this resource."
    },
    "total_spaces": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1
    },
    "send_notifications": {
      "type": "boolean",
      "description": "Email each customer that the booking changed (default false here; the API's own default is true)."
    },
    "ignore_service_schedule": {
      "type": "boolean",
      "description": "Allow moving outside the service's schedule."
    }
  }
}