Customers
Your client directory. Customers are referenced by invoices, quotes, expenses, and time entries.
GETList customers
GET/customers
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number (default: 1) |
| limit | integer | Items per page, max 100 (default: 20) |
| search | string | Search in name, email, company |
| sort | string | createdAt | -createdAt | name | -name |
curl "https://paymavo.com/api/v1/customers?search=acme" \
-H "Authorization: Bearer sk_live_xxx"GETGet a customer
GET/customers/{id}
curl https://paymavo.com/api/v1/customers/clx123 \
-H "Authorization: Bearer sk_live_xxx"POSTCreate a customer
POST/customers
| Parameter | Type | Description |
|---|---|---|
| name* | string | Full name (max 200 chars) |
| email* | Email address | |
| phone | string | Phone number |
| company | string | Company name |
| streetAddress | string | Street address |
| postalCode | string | Postal code |
| city | string | City |
| province | string | Province / state |
| country | string | Country |
| gstNumber | string | GST registration number |
| qstNumber | string | QST registration number |
| taxExempt | boolean | Tax exempt (default: false) |
curl -X POST https://paymavo.com/api/v1/customers \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "name": "Sophie Tremblay", "email": "sophie@example.com", "company": "Studio ST" }'PATCHUpdate a customer
PATCH/customers/{id}
curl -X PATCH https://paymavo.com/api/v1/customers/clx123 \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{ "phone": "+1-514-555-0100", "city": "Montréal" }'DELETEDelete a customer
DELETE/customers/{id}
curl -X DELETE https://paymavo.com/api/v1/customers/clx123 \
-H "Authorization: Bearer sk_live_xxx"