v1

latestOpenAPI 3.0.02026-08-068926279.2 KB
Clients

List all clients

Returns a list of all clients for the authenticated user. Use the select parameter for a simplified response suitable for dropdowns.

get/clients

Query parameters

selectstring

If present, returns simplified data (id, client_name) for dropdown usage

Response

Successful response

Example response

{
  "data": [
    {
      "id": 1,
      "team_id": 1,
      "name": "Acme Corporation",
      "source": "Referral",
      "address": "123 Main St, City, ST 12345",
      "tax_name": "Tax ID",
      "tax_number": "12-3456789",
      "status": {
        "id": 1,
        "name": "Active"
      },
      "sent_total": 15000,
      "collected_total": 12500,
      "outstanding_total": 2500,
      "average_days_to_pay": 14,
      "contacts": [
        {
          "id": 1,
          "team_id": 1,
          "client_id": 1,
          "title": "Mr.",
          "first_name": "John",
          "last_name": "Doe",
          "email": "john@example.com",
          "phone": "555-1234"
        }
      ],
      "projects_count": 5,
      "invoices_count": 12,
      "estimates_count": 3,
      "other_income_count": 2
    }
  ]
}
All 89 operations