文档

acuity-scheduling

试用

通过托管 OAuth 接入 Acuity Scheduling API,完成预约的创建、改期与取消。

它能做什么

通过托管 OAuth 代理访问 Acuity Scheduling,每次请求自动注入访问令牌。可读取预约、日历、服务类型、客户、屏蔽时段、可用日期/时间以及账户信息,也可对预约和客户进行创建、更新、改期与取消。认证使用环境变量 MATON_API_KEY,以 Bearer 形式发送;所有写操作在执行前都需要用户明确确认。

什么时候用它

  • 按日期、日历或客户条件筛选并列出预约
  • 查询指定服务类型在某月的可预约日期与具体时段
  • 改期或取消已有预约
  • 按姓名/电话搜索客户或新建客户档案

技能文档

Acuity Scheduling

Access the Acuity Scheduling API with managed OAuth authentication. Manage appointments, calendars, clients, availability, and more.

Quick Start

# List appointments
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/acuity-scheduling/api/v1/appointments?max=10')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Base URL

https://api.maton.ai/acuity-scheduling/{native-api-path}

Maton proxies requests to acuityscheduling.com and automatically injects your OAuth token.

Authentication

All requests require the Maton API key in the Authorization header:

Authorization: Bearer $MATON_API_KEY

Environment Variable: Set your API key as MATON_API_KEY:

export MATON_API_KEY="YOUR_API_KEY"

Getting Your API Key

  1. Sign in or create an account at maton.ai
  2. Go to maton.ai/settings
  3. Copy your API key

Connection Management

Manage your Acuity Scheduling OAuth connections at https://api.maton.ai.

List Connections

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections?app=acuity-scheduling&status=ACTIVE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Create Connection

python <<'EOF'
import urllib.request, os, json
data = json.dumps({'app': 'acuity-scheduling'}).encode()
req = urllib.request.Request('https://api.maton.ai/connections', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Get Connection

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Response:

{
  "connection": {
    "connection_id": "{connection_id}",
    "status": "ACTIVE",
    "creation_time": "2025-12-08T07:20:53.488460Z",
    "last_updated_time": "2026-01-31T20:03:32.593153Z",
    "url": "https://connect.maton.ai/?session_token=...",
    "app": "acuity-scheduling",
    "metadata": {}
  }
}

Open the returned url in a browser to complete OAuth authorization.

Delete Connection

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Specifying Connection

If you have multiple Acuity Scheduling connections, specify which one to use with the Maton-Connection header:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/acuity-scheduling/api/v1/appointments')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Maton-Connection', '{connection_id}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

If you have multiple connections, always include this header to ensure requests go to the intended account.

Security & Permissions

  • Access is scoped to appointments, calendars, clients, and availability within the connected Acuity Scheduling account.
  • All write operations require explicit user approval. Before executing any create, update, or delete call, confirm the target resource and intended effect with the user.

API Reference

Account Information

Get Account Info

GET /acuity-scheduling/api/v1/me

Returns account information including timezone, scheduling page URL, and plan details.

Response:

{
  "id": 12345,
  "email": "user@example.com",
  "timezone": "America/Los_Angeles",
  "name": "My Business",
  "schedulingPage": "https://app.acuityscheduling.com/schedule.php?owner=12345",
  "plan": "Professional",
  "currency": "USD"
}

Appointments

List Appointments

GET /acuity-scheduling/api/v1/appointments

Query Parameters:

ParameterTypeDescription
maxintegerMaximum results (default: 100)
minDatedateAppointments on or after this date
maxDatedateAppointments on or before this date
calendarIDintegerFilter by calendar
appointmentTypeIDintegerFilter by appointment type
canceledbooleanInclude canceled appointments (default: false)
firstNamestringFilter by client first name
lastNamestringFilter by client last name
emailstringFilter by client email
excludeFormsbooleanOmit intake forms for faster response
directionstringSort order: ASC or DESC (default: DESC)

Example:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/acuity-scheduling/api/v1/appointments?max=10&minDate=2026-02-01')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Response:

[
  {
    "id": 1630290133,
    "firstName": "Jane",
    "lastName": "McTest",
    "phone": "1235550101",
    "email": "jane.mctest@example.com",
    "date": "February 4, 2026",
    "time": "9:30am",
    "endTime": "10:20am",
    "datetime": "2026-02-04T09:30:00-0800",
    "type": "Consultation",
    "appointmentTypeID": 88791369,
    "duration": "50",
    "calendar": "Chris",
    "calendarID": 13499175,
    "canceled": false,
    "confirmationPage": "https://app.acuityscheduling.com/schedule.php?..."
  }
]

Get Appointment

GET /acuity-scheduling/api/v1/appointments/{id}

Create Appointment

POST /acuity-scheduling/api/v1/appointments
Content-Type: application/json

{
  "datetime": "2026-02-15T09:00",
  "appointmentTypeID": 123,
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "555-123-4567",
  "timezone": "America/New_York"
}

Required Fields:

  • datetime - Date and time (parseable by PHP's strtotime)
  • appointmentTypeID - Appointment type ID
  • firstName - Client's first name
  • lastName - Client's last name
  • email - Client's email

Optional Fields:

  • phone - Client phone number
  • calendarID - Specific calendar (auto-selected if omitted)
  • timezone - Client's timezone
  • certificate - Package or coupon code
  • notes - Admin notes
  • addonIDs - Array of addon IDs
  • fields - Array of form field values

Example:

python <<'EOF'
import urllib.request, os, json
data = json.dumps({
    'datetime': '2026-02-15T09:00',
    'appointmentTypeID': 123,
    'firstName': 'John',
    'lastName': 'Doe',
    'email': 'john.doe@example.com'
}).encode()
req = urllib.request.Request('https://api.maton.ai/acuity-scheduling/api/v1/appointments', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Update Appointment

PUT /acuity-scheduling/api/v1/appointments/{id}
Content-Type: application/json

{
  "firstName": "Jane",
  "lastName": "Smith",
  "email": "jane.smith@example.com"
}

Cancel Appointment

PUT /acuity-scheduling/api/v1/appointments/{id}/cancel

Returns the canceled appointment with canceled: true.

Reschedule Appointment

PUT /acuity-scheduling/api/v1/appointments/{id}/reschedule
Content-Type: application/json

{
  "datetime": "2026-02-20T10:00"
}

Note: The new datetime must be an available time slot.

Calendars

List Calendars

GET /acuity-scheduling/api/v1/calendars

Response:

[
  {
    "id": 13499175,
    "name": "Chris",
    "email": "",
    "replyTo": "chris@example.com",
    "description": "",
    "location": "",
    "timezone": "America/Los_Angeles"
  }
]

Appointment Types

List Appointment Types

GET /acuity-scheduling/api/v1/appointment-types

Query Parameters:

  • includeDeleted (boolean) - Include deleted types

Response:

[
  {
    "id": 88791369,
    "name": "Consultation",
    "active": true,
    "description": "",
    "duration": 50,
    "price": "45.00",
    "category": "",
    "color": "#ED7087",
    "private": false,
    "type": "service",
    "calendarIDs": [13499175],
    "schedulingUrl": "https://app.acuityscheduling.com/schedule.php?..."
  }
]

Availability

Get Available Dates

GET /acuity-scheduling/api/v1/availability/dates?month=2026-02&appointmentTypeID=123

Required Parameters:

  • month - Month to check (e.g., "2026-02")
  • appointmentTypeID - Appointment type ID

Optional Parameters:

  • calendarID - Specific calendar
  • timezone - Timezone for results (e.g., "America/New_York")

Response:

[
  {"date": "2026-02-09"},
  {"date": "2026-02-10"},
  {"date": "2026-02-11"}
]

Get Available Times

GET /acuity-scheduling/api/v1/availability/times?date=2026-02-10&appointmentTypeID=123

Required Parameters:

  • date - Date to check
  • appointmentTypeID - Appointment type ID

Optional Parameters:

  • calendarID - Specific calendar
  • timezone - Timezone for results

Response:

[
  {"time": "2026-02-10T09:00:00-0800", "slotsAvailable": 1},
  {"time": "2026-02-10T09:50:00-0800", "slotsAvailable": 1},
  {"time": "2026-02-10T10:40:00-0800", "slotsAvailable": 1}
]

Clients

List Clients

GET /acuity-scheduling/api/v1/clients

Query Parameters:

  • search - Filter by first name, last name, or phone

Example:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/acuity-scheduling/api/v1/clients?search=John')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Response:

[
  {
    "firstName": "Jane",
    "lastName": "McTest",
    "email": "jane.mctest@example.com",
    "phone": "(123) 555-0101",
    "notes": ""
  }
]

Create Client

POST /acuity-scheduling/api/v1/clients
Content-Type: application/json

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "phone": "555-123-4567"
}

Update Client

PUT /acuity-scheduling/api/v1/clients
Content-Type: application/json

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.updated@example.com"
}

Note: Client update/delete only works for clients with existing appointments.

Delete Client

DELETE /acuity-scheduling/api/v1/clients
Content-Type: application/json

{
  "firstName": "John",
  "lastName": "Doe"
}

Blocks

List Blocks

GET /acuity-scheduling/api/v1/blocks

Query Parameters:

  • max - Maximum results (default: 100)
  • minDate - Blocks on or after this date
  • maxDate - Blocks on or before this date
  • calendarID - Filter by calendar

Get Block

GET /acuity-scheduling/api/v1/blocks/{id}

Create Block

POST /acuity-scheduling/api/v1/blocks
Content-Type: application/json

{
  "start": "2026-02-15T12:00",
  "end": "2026-02-15T13:00",
  "calendarID": 1234,
  "notes": "Lunch break"
}

Response:

{
  "id": 9589304654,
  "calendarID": 13499175,
  "start": "2026-02-15T12:00:00-0800",
  "end": "2026-02-15T13:00:00-0800",
  "notes": "Lunch break",
  "description": "Sunday, February 15, 2026 12:00pm - 1:00pm"
}

Delete Block

DELETE /acuity-scheduling/api/v1/blocks/{id}

Returns 204 No Content on success.

Forms

List Forms

GET /acuity-scheduling/api/v1/forms

Response:

[
  {
    "id": 123,
    "name": "Client Intake Form",
    "appointmentTypeIDs": [456, 789],
    "fields": [
      {
        "id": 1,
        "name": "How did you hear about us?",
        "type": "dropdown",
        "options": ["Google", "Friend", "Social Media"],
        "required": true
      }
    ]
  }
]

Labels

List Labels

GET /acuity-scheduling/api/v1/labels

Response:

[
  {"id": 23116714, "name": "Checked In", "color": "green"},
  {"id": 23116715, "name": "Completed", "color": "pink"},
  {"id": 23116713, "name": "Confirmed", "color": "yellow"}
]

Pagination

Acuity Scheduling uses the max parameter to limit results. Use minDate and maxDate to paginate through date ranges:

# First page
GET /acuity-scheduling/api/v1/appointments?max=100&minDate=2026-01-01&maxDate=2026-01-31

# Next page
GET /acuity-scheduling/api/v1/appointments?max=100&minDate=2026-02-01&maxDate=2026-02-28

Code Examples

JavaScript

const response = await fetch(
  'https://api.maton.ai/acuity-scheduling/api/v1/appointments?max=10',
  {
    headers: {
      'Authorization': `Bearer ${process.env.MATON_API_KEY}`
    }
  }
);
const appointments = await response.json();

Python

import os
import requests

response = requests.get(
    'https://api.maton.ai/acuity-scheduling/api/v1/appointments',
    headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'},
    params={'max': 10}
)
appointments = response.json()

Notes

  • Datetime values must be parseable by PHP's strtotime() function
  • Timezones use IANA format (e.g., "America/New_York", "America/Los_Angeles")
  • Client update/delete requires clients to have existing appointments
  • Rescheduling requires the new datetime to be an available time slot
  • Use excludeForms=true for faster appointment list responses
  • IMPORTANT: When using curl commands, use curl -g when URLs contain brackets to disable glob parsing
  • IMPORTANT: When piping curl output to jq or other commands, environment variables like $MATON_API_KEY may not expand correctly in some shell environments. You may get "Invalid API key" errors when piping.

Error Handling

StatusMeaning
400Invalid request (e.g., time not available, client not found)
401Invalid or missing Maton API key
404Resource not found
429Rate limited
4xx/5xxPassthrough error from Acuity API

Troubleshooting: API Key Issues

  1. Check that the MATON_API_KEY environment variable is set:
echo $MATON_API_KEY
  1. Verify the API key is valid by listing connections:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Troubleshooting: Invalid App Name

  1. Ensure your URL path starts with acuity-scheduling. For example:
  • Correct: https://api.maton.ai/acuity-scheduling/api/v1/appointments
  • Incorrect: https://api.maton.ai/api/v1/appointments

Resources

相关技能

Acuity Scheduling (acuityscheduling.com). Use this skill for ANY Acuity Scheduling request — reading, creating, and updating data. Whenever a task involves Acuity Scheduling, use this skill instead of calling the API directly.

通过托管 OAuth 网关读写 Calendly 排程数据。

676 次安装14 星标

通过托管 OAuth 代理访问 Google Calendar API,读写日程与事件。

348 次安装21 星标

通过 Maton API 代理,使用托管 OAuth 管理 Zoho Bookings 的预约、服务、员工和工作区。

39 次安装

通过 OAuth 网关调度与管理 Zoom 会议、研讨会与云录制。

27 次安装1 星标

通过托管 OAuth 接入 Cal.com 排程 API,管理事件类型、预约、可用时段、排班与 Webhook。

52 次安装