> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Appointo

> Appointo is an appointment booking application designed for Shopify stores, enabling businesses to integrate online booking systems seamlessly into their websites without any coding required.

![Appointo logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/appointo.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=fc5ac2232965783a9556e5ee26c8feea)

* **Category:** scheduling & booking
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 11
* **Triggers:** 0
* **Slug:** `APPOINTO`
* **Version:** 20261101\_00

## Tools

> [accordion] Authenticate Appointo API Token
>
> **Slug:** `APPOINTO_AUTHENTICATE`
>
> Tool to authenticate with the Appointo API by validating the APPOINTO-TOKEN header. Use when verifying the token before subsequent API calls.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Booking
>
> **Slug:** `APPOINTO_CANCEL_BOOKING`
>
> Cancel an Appointo booking or cancel selected customers from it. Omit customer IDs to cancel the whole booking. Appointo limits cancellation requests to 100 per day.
>
> #### Input Parameters
>
> **booking\_id** `integer` *required*
>
> Booking ID to cancel
>
> **customer\_ids** `array`
>
> Array of customer IDs to cancel; omit to cancel entire booking
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Booking
>
> **Slug:** `APPOINTO_CREATE_BOOKING`
>
> Create a customer booking for an appointment and timeslot. An unauthorized response is returned as an empty bookings list; the provider documents a maximum of 100 creation requests per day.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the customer.
>
> **email** `string` *required*
>
> Email of the customer.
>
> **phone** `string`
>
> Phone number of the customer.
>
> **quantity** `integer`
>
> Number of bookings (default is 1).
>
> **timestring** `string` *required*
>
> ISO 8601 datetime string for the desired timeslot.
>
> **appointment\_id** `integer` *required*
>
> Appointo Appointment Id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Appointment Availability
>
> **Slug:** `APPOINTO_GET_APPOINTMENT_AVAILABILITY`
>
> Fetch calendar availability for a specific Appointo appointment from a start date, optionally through an end date. Availability can be filtered to specified team members; dates use YYYY-MM-DD format.
>
> #### Input Parameters
>
> **end\_date** `string`
>
> End date for availability range in YYYY-MM-DD format
>
> **start\_date** `string` *required*
>
> Start date for availability range in YYYY-MM-DD format
>
> **appointment\_id** `integer` *required*
>
> Appointment identifier
>
> **impersonated\_tms** `array`
>
> List of team member IDs to filter availability
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Appointments
>
> **Slug:** `APPOINTO_LIST_APPOINTMENTS`
>
> List Appointo appointments, optionally filtering by appointment ID or product ID. Results use offset pagination, with a default and maximum page size of 100.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of items per page (default and maximum is 100).
>
> **offset** `integer`
>
> Pagination offset, zero-based index (default is 0).
>
> **product\_id** `integer`
>
> Filter to fetch appointments for a specific product by its ID.
>
> **appointment\_id** `integer`
>
> Filter to fetch a single appointment by its ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Bookings
>
> **Slug:** `APPOINTO_LIST_BOOKINGS`
>
> List Appointo bookings or retrieve a booking by ID. Filter by past or upcoming status or search by product, customer, email, phone, or order name. Use limit and offset for pagination; the maximum page size is 100.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of bookings to return (1-100).
>
> **offset** `integer`
>
> Number of bookings to skip for pagination.
>
> **status** `string ("past" | "upcoming")`
>
> Filter bookings by status: 'past' or 'upcoming'.
>
> **booking\_id** `integer`
>
> Fetch a single booking by its ID.
>
> **search\_term** `string`
>
> Search bookings by product name, customer name, email, phone, or order name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products
>
> **Slug:** `APPOINTO_LIST_PRODUCTS`
>
> List products added in Appointo, optionally filtering by product name. Use limit and offset to browse pages; the default and maximum page size is 100.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of products to return (max 100; default server-side is 100)
>
> **offset** `string`
>
> Pagination offset token returned by a previous call
>
> **search\_term** `string`
>
> Filter products by name (case-insensitive substring match)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscription Contracts
>
> **Slug:** `APPOINTO_LIST_SUBSCRIPTION_CONTRACTS`
>
> List Appointo subscription contracts, optionally searching by product name, variant name, order number, or customer name. Use limit and offset to request a page; the action accepts a maximum limit of 100.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of subscription contracts to return per page (default and maximum is 100).
>
> **offset** `integer`
>
> Pagination offset, zero-based index (default is 0).
>
> **search\_term** `string`
>
> Search by product name, variant name, order number, or customer name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reschedule Booking
>
> **Slug:** `APPOINTO_RESCHEDULE_BOOKING`
>
> Reschedule an entire booking or selected customers to a new timeslot, optionally forcing the reschedule. An unauthorized response returns an unauthorized status and a placeholder booking.
>
> #### Input Parameters
>
> **override** `boolean`
>
> Force reschedule even if the timeslot is occupied.
>
> **booking\_id** `integer` *required*
>
> Booking ID to reschedule.
>
> **timestring** `string` *required*
>
> New timeslot timestamp in ISO 8601 format.
>
> **customer\_ids** `array`
>
> List of customer IDs to reschedule; if omitted, the entire booking is rescheduled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Booking Buffers
>
> **Slug:** `APPOINTO_UPDATE_BOOKING`
>
> Update buffer times for an existing booking. An unauthorized response returns an unauthorized status and a placeholder booking rather than updated booking data.
>
> #### Input Parameters
>
> **booking\_id** `integer` *required*
>
> Booking ID to update
>
> **end\_buffer\_time** `integer`
>
> End buffer time in minutes, must be greater than 0
>
> **start\_buffer\_time** `integer`
>
> Start buffer time in minutes, must be greater than 0
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert Appointment Configuration
>
> **Slug:** `APPOINTO_UPSERT_APPOINTMENT_CONFIG`
>
> Create or update an Appointo appointment's configuration, weekly availability, and date-specific overrides. Use this to set the appointment's scheduling and availability settings.
>
> #### Input Parameters
>
> **config** `object` *required*
>
> Appointment configuration settings
>
> **override** `array` *required*
>
> Date-specific overrides
>
> **appointment\_id** `integer` *required*
>
> ID of the appointment to configure
>
> **availabilities** `array` *required*
>
> Weekly availability definitions
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
