Customers API
Customers represent the people who make bookings with your business. The Customers API lets you manage customer records and access their booking history.
What is a Customer?
A customer record stores contact information and tracks booking history. Each booking in EquipDash is linked to a customer, allowing you to:
- Track repeat customers and their preferences
- Maintain contact information for communications
- View complete booking history
- Add notes and internal tags
Customer Structure
Customer
├── Contact Info (name, email, phone)
├── Address (optional)
├── Bookings[] (all their reservations)
├── Notes[] (internal staff notes)
└── FormResponses[] (waiver/survey submissions)
Key Fields
| Field | Description |
|---|---|
first_name, last_name | Customer's name |
email | Email address (unique per supplier) |
phone, phone_country_code | Phone number with country code |
gender | Optional: male, female, other |
date_of_birth | Optional: For age-restricted activities |
address | Street, city, state, postcode, country |
API Endpoints
Customer Management
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/customers | List all customers with search/filtering | customers:read |
GET | /v1/customers/{id} | Get a single customer with details | customers:read |
POST | /v1/customers | Create a new customer | customers:write |
PATCH | /v1/customers/{id} | Update customer details | customers:write |
DELETE | /v1/customers/{id} | Delete a customer record | customers:write |
Booking History
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/customers/{id}/bookings | Get customer's booking history | customers:read |
Customer Notes
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/customers/{id}/notes | List customer notes | customers:read |
POST | /v1/customers/{id}/notes | Add a note | customers:write |
DELETE | /v1/customers/{id}/notes/{noteId} | Delete a note | customers:write |
Common Use Cases
Syncing with CRM
Export customers to sync with your CRM system:
curl "https://app.equipdash.com/api/v1/customers?per_page=100" \
-H "Authorization: Bearer YOUR_API_KEY"
Finding Existing Customers
Search by email before creating a new customer:
curl "https://app.equipdash.com/api/v1/customers?email=john@example.com" \
-H "Authorization: Bearer YOUR_API_KEY"
Creating Customers from Your Website
Create customer records when users sign up:
curl -X POST "https://app.equipdash.com/api/v1/customers" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Jane",
"last_name": "Smith",
"email": "jane@example.com",
"phone": "0412345678",
"phone_country_code": "+61"
}'
Avoiding Duplicates
The email field is unique per supplier. When creating customers:
- First search for existing customer by email
- If found, use existing customer ID
- If not found, create new customer