Skip to main content
The Customers API allows you to manage customer directory records, including their contact details and profile fields.

GET /customers

Retrieve a paginated list of customers in your organization.
integer
default:"50"
Number of customers to return per page. Maximum value is 50.

GET /customers/{id}

Retrieve details for a single customer by ID.
string
required
The unique ID of the customer.

POST /customers

Create a new customer. Note that organizations on the Free plan are limited to a maximum of 100 customers.
string
required
The customer’s first name.
string
required
The customer’s last name.
string
required
The customer’s email address.
string
The customer’s phone number.
string
Custom profile image URL.

PUT /customers/{id}

Update an existing customer’s properties.
string
required
The unique ID of the customer.
string
The customer’s first name.
string
The customer’s last name.
string
The customer’s phone number.

DELETE /customers/{id}

Delete a customer record permanently.
string
required
The unique ID of the customer.
A successful deletion returns 204 No Content with an empty response body.