KosmoKrator

productivity

Acuity Scheduling CLI for AI Agents

Use the Acuity Scheduling CLI from KosmoKrator to call Acuity Scheduling tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Acuity Scheduling CLI Setup

Acuity Scheduling can be configured headlessly with `kosmokrator integrations:configure acuity-scheduling`.

Install, configure, and verify
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure acuity-scheduling --enable --read allow --write ask --json
kosmokrator integrations:doctor acuity-scheduling --json
kosmokrator integrations:status --json

Credentials

Authentication type: basic or bearer basic_or_bearer. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

KeyEnv varTypeRequiredLabel
access_token ACUITY_SCHEDULING_ACCESS_TOKEN Secret secret no OAuth Access Token
user_id ACUITY_SCHEDULING_USER_ID Text text no User ID
api_key ACUITY_SCHEDULING_API_KEY Secret secret no API Key
url ACUITY_SCHEDULING_URL URL url no API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call
kosmo integrations:call acuity-scheduling.acuity_list_appointments '{"minDate":"example_minDate","maxDate":"example_maxDate","calendarID":1,"appointmentTypeID":1,"max":1,"direction":"example_direction"}' --json
Provider shortcut
kosmo integrations:acuity-scheduling acuity_list_appointments '{"minDate":"example_minDate","maxDate":"example_maxDate","calendarID":1,"appointmentTypeID":1,"max":1,"direction":"example_direction"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands
kosmo integrations:docs acuity-scheduling --json
kosmo integrations:docs acuity-scheduling.acuity_list_appointments --json
kosmo integrations:schema acuity-scheduling.acuity_list_appointments --json
kosmo integrations:search "Acuity Scheduling" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

acuity-scheduling.acuity_list_appointments

List appointments from Acuity Scheduling. Returns upcoming and past appointments with client details, date/time, and status. Use filters to narrow results by date range, calendar, or appointment type.

Read read
Parameters
minDate, maxDate, calendarID, appointmentTypeID, max, direction
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_appointments '{"minDate":"example_minDate","maxDate":"example_maxDate","calendarID":1,"appointmentTypeID":1,"max":1,"direction":"example_direction"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_appointments '{"minDate":"example_minDate","maxDate":"example_maxDate","calendarID":1,"appointmentTypeID":1,"max":1,"direction":"example_direction"}' --json

acuity-scheduling.acuity_get_appointment

Get full details of a specific appointment in Acuity Scheduling by its ID. Returns client info, date/time, location, forms, and status.

Read read
Parameters
id
Generic call
kosmo integrations:call acuity-scheduling.acuity_get_appointment '{"id":1}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_get_appointment '{"id":1}' --json

acuity-scheduling.acuity_create_appointment

Create an appointment in Acuity Scheduling.

Write write
Parameters
body
Generic call
kosmo integrations:call acuity-scheduling.acuity_create_appointment '{"body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_create_appointment '{"body":"example_body"}' --json

acuity-scheduling.acuity_update_appointment

Update editable Acuity Scheduling appointment details such as client info, notes, fields, labels, or smsOptIn.

Write write
Parameters
id, body
Generic call
kosmo integrations:call acuity-scheduling.acuity_update_appointment '{"id":1,"body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_update_appointment '{"id":1,"body":"example_body"}' --json

acuity-scheduling.acuity_reschedule_appointment

Reschedule an appointment to a new datetime, calendar, or both.

Write write
Parameters
id, body
Generic call
kosmo integrations:call acuity-scheduling.acuity_reschedule_appointment '{"id":1,"body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_reschedule_appointment '{"id":1,"body":"example_body"}' --json

acuity-scheduling.acuity_list_appointment_payments

Retrieve payment transactions for a specific Acuity Scheduling appointment.

Read read
Parameters
id
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_appointment_payments '{"id":1}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_appointment_payments '{"id":1}' --json

acuity-scheduling.acuity_list_clients

List clients from Acuity Scheduling. Search by name, email, or phone. Returns client contact information and history.

Read read
Parameters
search, email, max
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_clients '{"search":"example_search","email":"example_email","max":1}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_clients '{"search":"example_search","email":"example_email","max":1}' --json

acuity-scheduling.acuity_create_client

Create a new Acuity Scheduling client record.

Write write
Parameters
body
Generic call
kosmo integrations:call acuity-scheduling.acuity_create_client '{"body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_create_client '{"body":"example_body"}' --json

acuity-scheduling.acuity_update_client

Update an Acuity Scheduling client by lookup parameters and replacement fields.

Write write
Parameters
lookup, body
Generic call
kosmo integrations:call acuity-scheduling.acuity_update_client '{"lookup":"example_lookup","body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_update_client '{"lookup":"example_lookup","body":"example_body"}' --json

acuity-scheduling.acuity_list_calendars

List all calendars in Acuity Scheduling. Returns calendar IDs, names, and timezone info. Use calendar IDs to filter appointments.

Read read
Parameters
none
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_calendars '{}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_calendars '{}' --json

acuity-scheduling.acuity_list_appointment_types

List all appointment types (services) in Acuity Scheduling. Returns type IDs, names, duration, price, and category. Use type IDs to filter appointments or check availability.

Read read
Parameters
none
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_appointment_types '{}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_appointment_types '{}' --json

acuity-scheduling.acuity_cancel_appointment

Cancel an existing appointment in Acuity Scheduling. Requires the appointment ID. The appointment will be marked as cancelled and the client will be notified according to notification settings.

Write write
Parameters
id
Generic call
kosmo integrations:call acuity-scheduling.acuity_cancel_appointment '{"id":1}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_cancel_appointment '{"id":1}' --json

acuity-scheduling.acuity_get_availability

Get available time slots for booking in Acuity Scheduling. Returns open times for a given appointment type, date, and optional calendar.

Read read
Parameters
appointmentTypeID, date, calendarID, timezone
Generic call
kosmo integrations:call acuity-scheduling.acuity_get_availability '{"appointmentTypeID":1,"date":"example_date","calendarID":1,"timezone":"example_timezone"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_get_availability '{"appointmentTypeID":1,"date":"example_date","calendarID":1,"timezone":"example_timezone"}' --json

acuity-scheduling.acuity_get_availability_dates

Return dates with availability for a month and appointment type.

Read read
Parameters
params
Generic call
kosmo integrations:call acuity-scheduling.acuity_get_availability_dates '{"params":"example_params"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_get_availability_dates '{"params":"example_params"}' --json

acuity-scheduling.acuity_get_availability_classes

Return available classes for a month.

Read read
Parameters
params
Generic call
kosmo integrations:call acuity-scheduling.acuity_get_availability_classes '{"params":"example_params"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_get_availability_classes '{"params":"example_params"}' --json

acuity-scheduling.acuity_list_forms

List intake forms and their fields from Acuity Scheduling.

Read read
Parameters
none
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_forms '{}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_forms '{}' --json

acuity-scheduling.acuity_list_products

List products and packages from Acuity Scheduling.

Read read
Parameters
none
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_products '{}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_products '{}' --json

acuity-scheduling.acuity_list_orders

List package, gift certificate, subscription, and product orders from Acuity Scheduling.

Read read
Parameters
params
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_orders '{"params":"example_params"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_orders '{"params":"example_params"}' --json

acuity-scheduling.acuity_get_order

Get details about a single Acuity Scheduling order by ID.

Read read
Parameters
id
Generic call
kosmo integrations:call acuity-scheduling.acuity_get_order '{"id":1}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_get_order '{"id":1}' --json

acuity-scheduling.acuity_create_certificate

Create a package or coupon certificate code in Acuity Scheduling.

Write write
Parameters
body
Generic call
kosmo integrations:call acuity-scheduling.acuity_create_certificate '{"body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_create_certificate '{"body":"example_body"}' --json

acuity-scheduling.acuity_list_blocks

List blocked-off times for the authenticated Acuity Scheduling user.

Read read
Parameters
params
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_blocks '{"params":"example_params"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_blocks '{"params":"example_params"}' --json

acuity-scheduling.acuity_create_block

Block off time on an Acuity Scheduling calendar.

Write write
Parameters
body
Generic call
kosmo integrations:call acuity-scheduling.acuity_create_block '{"body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_create_block '{"body":"example_body"}' --json

acuity-scheduling.acuity_delete_block

Delete a blocked-off time by ID.

Write write
Parameters
id
Generic call
kosmo integrations:call acuity-scheduling.acuity_delete_block '{"id":1}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_delete_block '{"id":1}' --json

acuity-scheduling.acuity_list_webhooks

List dynamic webhook subscriptions in Acuity Scheduling.

Read read
Parameters
none
Generic call
kosmo integrations:call acuity-scheduling.acuity_list_webhooks '{}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_list_webhooks '{}' --json

acuity-scheduling.acuity_create_webhook

Create a dynamic webhook subscription for Acuity Scheduling events.

Write write
Parameters
body
Generic call
kosmo integrations:call acuity-scheduling.acuity_create_webhook '{"body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_create_webhook '{"body":"example_body"}' --json

acuity-scheduling.acuity_delete_webhook

Delete a dynamic webhook subscription by ID.

Write write
Parameters
id
Generic call
kosmo integrations:call acuity-scheduling.acuity_delete_webhook '{"id":1}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_delete_webhook '{"id":1}' --json

acuity-scheduling.acuity_api_get

Call any Acuity Scheduling API v1 GET endpoint.

Read read
Parameters
path, params
Generic call
kosmo integrations:call acuity-scheduling.acuity_api_get '{"path":"example_path","params":"example_params"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_api_get '{"path":"example_path","params":"example_params"}' --json

acuity-scheduling.acuity_api_post

Call any Acuity Scheduling API v1 POST endpoint.

Write write
Parameters
path, body
Generic call
kosmo integrations:call acuity-scheduling.acuity_api_post '{"path":"example_path","body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_api_post '{"path":"example_path","body":"example_body"}' --json

acuity-scheduling.acuity_api_put

Call any Acuity Scheduling API v1 PUT endpoint.

Write write
Parameters
path, body
Generic call
kosmo integrations:call acuity-scheduling.acuity_api_put '{"path":"example_path","body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_api_put '{"path":"example_path","body":"example_body"}' --json

acuity-scheduling.acuity_api_delete

Call any Acuity Scheduling API v1 DELETE endpoint.

Write write
Parameters
path, body
Generic call
kosmo integrations:call acuity-scheduling.acuity_api_delete '{"path":"example_path","body":"example_body"}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_api_delete '{"path":"example_path","body":"example_body"}' --json

acuity-scheduling.acuity_get_current_user

Get the currently authenticated Acuity Scheduling user profile. Returns user name, email, timezone, and account details.

Read read
Parameters
none
Generic call
kosmo integrations:call acuity-scheduling.acuity_get_current_user '{}' --json
Shortcut
kosmo integrations:acuity-scheduling acuity_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

acuity-scheduling.acuity_list_appointments 6 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_appointments --json
ParameterTypeRequiredDescription
minDate string no Earliest appointment date to return (ISO 8601, e.g., "2026-01-01").
maxDate string no Latest appointment date to return (ISO 8601, e.g., "2026-12-31").
calendarID integer no Filter by calendar ID.
appointmentTypeID integer no Filter by appointment type ID.
max integer no Maximum number of appointments to return (default: 100).
direction string no Sort direction: "asc" (oldest first) or "desc" (newest first). Default: "desc".
acuity-scheduling.acuity_get_appointment 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_get_appointment --json
ParameterTypeRequiredDescription
id integer yes The appointment ID.
acuity-scheduling.acuity_create_appointment 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_create_appointment --json
ParameterTypeRequiredDescription
body object yes Appointment body with datetime, appointmentTypeID, firstName, lastName, email, and optional calendarID, timezone, fields, notes, labels, or smsOptIn.
acuity-scheduling.acuity_update_appointment 2 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_update_appointment --json
ParameterTypeRequiredDescription
id integer yes Appointment ID.
body object yes Editable appointment fields.
acuity-scheduling.acuity_reschedule_appointment 2 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_reschedule_appointment --json
ParameterTypeRequiredDescription
id integer yes Appointment ID.
body object yes Reschedule payload such as datetime, calendarID, admin, and noEmail.
acuity-scheduling.acuity_list_appointment_payments 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_appointment_payments --json
ParameterTypeRequiredDescription
id integer yes Appointment ID.
acuity-scheduling.acuity_list_clients 3 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_clients --json
ParameterTypeRequiredDescription
search string no Search query to filter clients by name, email, or phone.
email string no Filter clients by exact email address.
max integer no Maximum number of clients to return.
acuity-scheduling.acuity_create_client 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_create_client --json
ParameterTypeRequiredDescription
body object yes Client body such as firstName, lastName, email, and phone.
acuity-scheduling.acuity_update_client 2 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_update_client --json
ParameterTypeRequiredDescription
lookup object yes Query parameters used to identify the client, such as email.
body object yes Client fields to update.
acuity-scheduling.acuity_list_calendars 0 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_calendars --json
ParameterTypeRequiredDescription
No parameters.
acuity-scheduling.acuity_list_appointment_types 0 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_appointment_types --json
ParameterTypeRequiredDescription
No parameters.
acuity-scheduling.acuity_cancel_appointment 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_cancel_appointment --json
ParameterTypeRequiredDescription
id integer yes The appointment ID to cancel.
acuity-scheduling.acuity_get_availability 4 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_get_availability --json
ParameterTypeRequiredDescription
appointmentTypeID integer yes The appointment type ID to check availability for.
date string yes The date to check availability for (YYYY-MM-DD format, e.g., "2026-04-10").
calendarID integer no Filter availability for a specific calendar.
timezone string no Timezone for the returned times (e.g., "America/New_York"). Defaults to the account timezone.
acuity-scheduling.acuity_get_availability_dates 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_get_availability_dates --json
ParameterTypeRequiredDescription
params object yes Query parameters such as appointmentTypeID and month.
acuity-scheduling.acuity_get_availability_classes 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_get_availability_classes --json
ParameterTypeRequiredDescription
params object no Query parameters such as appointmentTypeID and month.
acuity-scheduling.acuity_list_forms 0 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_forms --json
ParameterTypeRequiredDescription
No parameters.
acuity-scheduling.acuity_list_products 0 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_products --json
ParameterTypeRequiredDescription
No parameters.
acuity-scheduling.acuity_list_orders 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_orders --json
ParameterTypeRequiredDescription
params object no Optional order query parameters.
acuity-scheduling.acuity_get_order 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_get_order --json
ParameterTypeRequiredDescription
id integer yes Order ID.
acuity-scheduling.acuity_create_certificate 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_create_certificate --json
ParameterTypeRequiredDescription
body object yes Certificate body. Submit productID or couponID, with optional certificate and email.
acuity-scheduling.acuity_list_blocks 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_blocks --json
ParameterTypeRequiredDescription
params object no Optional block query parameters.
acuity-scheduling.acuity_create_block 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_create_block --json
ParameterTypeRequiredDescription
body object yes Block body with date/time, calendar, and duration fields accepted by Acuity.
acuity-scheduling.acuity_delete_block 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_delete_block --json
ParameterTypeRequiredDescription
id integer yes Block ID.
acuity-scheduling.acuity_list_webhooks 0 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_list_webhooks --json
ParameterTypeRequiredDescription
No parameters.
acuity-scheduling.acuity_create_webhook 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_create_webhook --json
ParameterTypeRequiredDescription
body object yes Webhook body with event and target URL.
acuity-scheduling.acuity_delete_webhook 1 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_delete_webhook --json
ParameterTypeRequiredDescription
id integer yes Webhook ID.
acuity-scheduling.acuity_api_get 2 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_api_get --json
ParameterTypeRequiredDescription
path string yes API path such as /forms or /orders.
params object no Query parameters.
acuity-scheduling.acuity_api_post 2 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_api_post --json
ParameterTypeRequiredDescription
path string yes API path.
body object no JSON body.
acuity-scheduling.acuity_api_put 2 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_api_put --json
ParameterTypeRequiredDescription
path string yes API path.
body object no JSON body.
acuity-scheduling.acuity_api_delete 2 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_api_delete --json
ParameterTypeRequiredDescription
path string yes API path.
body object no JSON body.
acuity-scheduling.acuity_get_current_user 0 parameters
Schema command
kosmo integrations:schema acuity-scheduling.acuity_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.