Clients API

The Clients API allows you to programmatically manage your client database.

Endpoints

List all clients

GET /v1/clients

Returns a paginated list of all your clients.

Query Parameters

• page - Page number (default: 1)
• limit - Items per page (default: 20, max: 100)
• search - Search by name or email

Response

{
  "data": [
    {
      "id": "cli_abc123",
      "name": "John Smith",
      "email": "john@example.com",
      "phone": "+1 555-123-4567",
      "company": "ABC Realty",
      "created_at": "2026-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150
  }
}

Get a client

GET /v1/clients/:id

Returns a single client with all details and their listings.

Create a client

POST /v1/clients

Request Body

{
  "name": "John Smith",
  "email": "john@example.com",
  "phone": "+1 555-123-4567",
  "company": "ABC Realty",
  "notes": "Prefers morning shoots"
}

Update a client

PATCH /v1/clients/:id

Updates the specified fields on a client.

Delete a client

DELETE /v1/clients/:id

Deletes a client. Their listings will be preserved but unassigned.

Client Listings

Get client's listings

GET /v1/clients/:id/listings

Returns all listings assigned to a specific client.

Assign listing to client

POST /v1/clients/:id/listings/:listing_id

Assigns a listing to a client and sends them a notification email.