Skip to main content

Appointments

Access and search scheduled appointments for your shop.

What You Can Ask​

Today's Schedule​

Show me today's appointments
What appointments do we have this morning?
Who's scheduled for today at shop 123?

Date Range Queries​

Show me appointments for this week
Find appointments between Jan 1 and Jan 31
What's scheduled for next Monday?
List appointments for tomorrow

Customer-Specific Appointments​

Find all appointments for customer 456
Show me Sarah Johnson's appointments
What time is customer 123 scheduled?

Vehicle Appointments​

Show me appointments for vehicle 789
Find all appointments for this VIN

By Status​

Show me confirmed appointments
Find pending appointments
List cancelled appointments

Examples by Role​

Service Advisor:

Show me my appointments for today
Who's my 10am appointment?

Front Desk:

Who's scheduled in the next hour?
List today's arrivals

Shop Manager:

How many appointments do we have this week?
What's tomorrow's workload look like?

What You'll Get​

Each appointment includes:

  • Customer name and contact info
  • Date and time scheduled
  • Vehicle information
  • Service requested
  • Duration
  • Status (confirmed, pending, completed, cancelled)
  • Service advisor assigned
  • Special notes or instructions

Technical Reference​

Tool: appointments​

Search and filter appointments, or get a specific appointment by ID.

Parameters​

ParameterTypeRequiredDescriptionDefault
idnumberNoGet specific appointment by ID-
searchstringNoSearch by customer name or vehicle info-
shopnumberNoShop IDDefault shop
customer_idnumberNoFilter by customer ID-
vehicle_idnumberNoFilter by vehicle ID-
start_datestringNoStart date (YYYY-MM-DD)-
end_datestringNoEnd date (YYYY-MM-DD)-
updated_startstringNoUpdated after date (YYYY-MM-DD)-
updated_endstringNoUpdated before date (YYYY-MM-DD)-
statusstringNoFilter by status-
sortstringNoSort property-
sort_directionstringNoASC or DESC-
limitnumberNoMax results (max: 100)20
pagenumberNoPage number0

Result Limits​

⚠️ Important: Results are limited to 25 appointments maximum to keep responses manageable.

When results are truncated, you'll see:

WARNING: ⚠️ SHOWING ONLY 10 OF 100 TOTAL APPOINTMENTS ⚠️

To see more, use filters:

  • Date ranges (start_date, end_date)
  • Filter by customer (customer_id)
  • Filter by vehicle (vehicle_id)