Customers Tools

Search, create, and update customer records. View booking history and manage internal notes.

Required scope: customers:read for read tools, customers:write for write tools

Tools Overview

Tool	Description	Read-only?
list_customers	List customers with optional filters	Yes
get_customer	Get detailed customer information with booking history, by customer or booking ID	Yes
search_customers	Search customers by name, email, or phone	Yes
create_customer	Create a new customer	No
update_customer	Update an existing customer	No
get_customer_notes	Get all internal notes on a customer	Yes
add_customer_note	Add an internal note to a customer	No

---

list_customers

List customers with optional search and date filters.

Parameters

Name	Type	Required	Description
search	string	No	Search by name, organization name, email, or phone
created_after	string	No	Filter customers created on or after this date (e.g., today, this week, 2026-02-10)
created_before	string	No	Filter customers created on or before this date
sort	string	No	Sort order: name (default) or newest
limit	integer	No	Number of results (default 10)

---

get_customer

Get detailed customer information including phone, email and booking history.

Parameters

Name	Type	Required	Description
customer_id	integer	One of the two	The customer ID. A booking row's customer_id, never its booking id
booking_id	integer	One of the two	A booking ID. Returns the customer on that booking

Passing a booking ID as customer_id returns an error that says so and gives the right customer_id.

---

search_customers

Search for customers by name, organization name (school, club, company), email, or phone.

Parameters

Name	Type	Required	Description
query	string	Yes	Search query

---

create_customer

Create a new customer.

Parameters

Name	Type	Required	Description
first_name	string	Yes	First name
last_name	string	Yes	Last name
email	string	No	Email address
phone	string	No	Phone number

---

update_customer

Update an existing customer.

Parameters

Name	Type	Required	Description
customer_id	integer	Yes	The customer ID to update
first_name	string	No	New first name
last_name	string	No	New last name
email	string	No	New email address
phone	string	No	New phone number
user_confirmed	boolean	Yes	Must be true to update

---

get_customer_notes

Get all internal notes on a customer profile.

Parameters

Name	Type	Required	Description
customer_id	integer	Yes	The customer ID

---

add_customer_note

Add an internal note to a customer profile.

Parameters

Name	Type	Required	Description
customer_id	integer	Yes	The customer ID
note	string	Yes	The note text to add

---

Related

• Customers REST API - REST API endpoints for customers
• Bookings Tools - Create bookings for customers