Customers API

Manage customer records through the Customers API. All endpoints require authentication and are scoped to your organization.

List Customers

Retrieve a list of all customers in your organization.

curl https://api.lawnledgercrm.com/api/customers \
  -b cookies.txt

Response:

{
  "data": [
    {
      "id": "cust_abc123",
      "name": "John Smith",
      "email": "john@example.com",
      "phone": "555-0100",
      "address": "123 Main St, Springfield, IL 62701",
      "notes": "Preferred mowing day: Thursday",
      "createdAt": "2025-03-15T10:00:00Z",
      "updatedAt": "2025-06-01T14:30:00Z"
    }
  ]
}

Query Parameters

Parameter	Type	Description
`search`	string	Search by name, email, or phone
`tag`	string	Filter by tag name
`page`	number	Page number (default: 1)
`limit`	number	Results per page (default: 50)

Example with filters:

curl "https://api.lawnledgercrm.com/api/customers?search=smith&limit=10" \
  -b cookies.txt

Get Customer

Retrieve a single customer by ID.

curl https://api.lawnledgercrm.com/api/customers/cust_abc123 \
  -b cookies.txt

Create Customer

Create a new customer record.

curl -X POST https://api.lawnledgercrm.com/api/customers \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{
    "name": "Jane Doe",
    "email": "jane@example.com",
    "phone": "555-0200",
    "address": "456 Oak Ave, Springfield, IL 62702",
    "notes": "Has two dogs in backyard"
  }'

Required Fields

Field	Type	Description
`name`	string	Customer’s full name or business name

Optional Fields

Field	Type	Description
`email`	string	Email address
`phone`	string	Phone number
`address`	string	Billing address
`notes`	string	Internal notes

Update Customer

Update an existing customer.

curl -X PUT https://api.lawnledgercrm.com/api/customers/cust_abc123 \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{
    "phone": "555-0300",
    "notes": "Updated phone number"
  }'

Delete Customer

Delete a customer record.

curl -X DELETE https://api.lawnledgercrm.com/api/customers/cust_abc123 \
  -b cookies.txt

⚠️

Deleting a customer also removes their properties, but does not delete associated invoices, estimates, or contracts. Those records are preserved for accounting purposes.

Overview Invoices