List All Customers — CurbWaste API Reference Guide

Use this endpoint to retrieve a paginated list of customers in your CurbWaste account. Each item returns the full customer profile. Narrow results with an optional searchTerm and control pagination with page and limit.

Endpoint

GET /v1/customers

Base URL: https://api.curbwaste.com

Required Scope

Your API key must include the customers:read scope to call this endpoint.

Query Parameters

string

Case-insensitive contains match against displayName, customerId, email, or phone. Maximum 255 characters.

integer

default:"1"

The page number to return. Must be 1 or greater. Defaults to 1.

integer

default:"25"

The number of results to return per page. Must be between 1 and 100. Defaults to 25.

Example Request

curl "https://api.curbwaste.com/v1/customers?page=1&limit=25&searchTerm=Acme" \
  -H "Authorization: Bearer cw_live_YOUR_API_KEY"

Example Response

200 OK

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayName": "Acme Corp",
      "customerId": "C001",
      "status": "active",
      "email": "billing@acmecorp.com",
      "phone": "+15550001234",
      "companyName": "Acme Corporation",
      "createdAt": "2024-01-15T08:30:00.000Z",
      "updatedAt": "2024-06-10T14:22:45.000Z"
    }
  ],
  "page": 1,
  "limit": 25,
  "total": 1
}

Response Fields

array

required

An array of customer profiles matching your query. Returns an empty array when no results are found.

Show data[] — PublicCustomer

string (uuid)

required

The unique identifier for the customer, formatted as a UUID.

string

required

The human-readable name used to identify the customer in the CurbWaste dashboard and communications.

string

required

CurbWaste CRM customer number (system-assigned, e.g. C001). May be an empty string. Not partner-supplied.

string

required

The current status of the customer account. One of active or inactive.

string | null

The customer’s email address, or null if unset.

string | null

The customer’s phone number, or null if unset.

string | null

The customer’s company name, or null if unset.

string (datetime) | null

ISO 8601 creation timestamp, or null when unavailable.

string (datetime) | null

ISO 8601 last-updated timestamp, or null when unavailable.

integer

required

The current page number returned in this response.

integer

required

The maximum number of items returned per page, as requested.

integer

required

The total number of customers matching your query across all pages.

Errors

Status Code	Meaning
`401 Unauthorized`	Your API key is missing or invalid. Create or rotate a key in the Developer Platform.
`403 Forbidden`	Your API key does not have the `customers:read` scope. Create a key with that scope in the Developer Platform.

Catalog

Customers

Locations

Zones

List All Customers — CurbWaste API Reference Guide

Endpoint

Required Scope

Query Parameters

Example Request

Example Response

Response Fields

Errors

​Endpoint

​Required Scope

​Query Parameters

​Example Request

​Example Response

​Response Fields

​Errors

Endpoint

Required Scope

Query Parameters

Example Request

Example Response

Response Fields

Errors