Customers

What a customer is

Customers are the account hub in CurbWaste. Locations, catalog pricing, and related resources hang off a customer. This page covers the Customer resource itself; other domains have their own concept pages as they ship (and appear in the API Reference today). Work with customers under /v1/customers.

In the platform

Domain	Relationship to Customer
Locations	Service sites and addresses belong to a customer (referenced by customer UUID).
Catalog & pricing	SKUs, services, and pricelists; some pricing is scoped to a specific customer.
Webhooks & MCP	Customer writes emit events; AI agents can work with customers (and other domains) via scoped tools.

Identifiers

Field	What it is	How to use it
`id`	Stable UUID	Join key after create. Use it in customer paths (`/v1/customers/{id}`) and when other endpoints ask for a customer UUID.
`customerId`	CurbWaste CRM number (e.g. `C001`)	System-assigned display number. Searchable via `searchTerm`. Not writable on create/update.

On the Customer resource, customerId is the CRM number. When Locations or catalog pricing inputs require a UUID customerId, pass the Customer’s id, not the CRM number.

Customer profile

List and get return the same profile, wrapped as { "data": … }.

Field	Type	Description
`id`	UUID	Stable CurbWaste id
`displayName`	string	Display name
`customerId`	string	CRM customer number (may be empty string)
`status`	`active` \| `inactive`	Read-only; derived from the CRM active flag
`email`	string \| null	Optional
`phone`	string \| null	Optional (max 50)
`companyName`	string \| null	Optional
`createdAt`	string \| null	ISO-8601
`updatedAt`	string \| null	ISO-8601

What you can change

Operation	Body fields
`POST` create	Required: `displayName`. Optional: `email`, `phone`, `companyName`
`PATCH` update	Any of `displayName`, `email`, `phone`, `companyName` (at least one required)

status and the CRM customerId are read-only on the profile. Successful create/update also emit customer.created / customer.updated webhook events.

Finding customers

GET /v1/customers returns the full profile for each item. Optional searchTerm matches displayName, customerId (CRM number), email, or phone (case-insensitive contains). Pagination uses page and limit. For the create → store UUID → update workflow, see Sync customers. For request and response details, see List customers.

Sync customers

Keep your system aligned using CurbWaste id as the join key.

Webhooks

React to create and update events with signed deliveries.

Customers API

Paths, params, and response shapes for /v1/customers.

Get Started

Core Concepts

Guides

API overview

What a customer is

In the platform

Identifiers

Customer profile

What you can change

Finding customers

Sync customers

Webhooks

Customers API

​What a customer is

​In the platform

​Identifiers

​Customer profile

​What you can change

​Finding customers

​Related

Sync customers

Webhooks

Customers API

What a customer is

In the platform

Identifiers

Customer profile

What you can change

Finding customers

Related