Manage client companies for work order organization and reporting.
Clients represent your end-customers (e.g., "Retail Chain X", "Enterprise Corp"). Tag work orders with a client_id to track work and costs by customer.
Retrieve a paginated list of client companies.
GET /clients
Query Parameters:
| Parameter | Description |
|---|---|
columns | Fields to include in response |
per_page | Results per page |
f_deactivated | Filter by deactivated status (0 or 1) |
f_deleted | Filter by deleted status (0 or 1) |
list | Saved list/filter name |
smart_list | Sort by recently used/created |
{
"results": [
{
"id": 102,
"name": "Retail Chain X",
"active": true,
"created": "2024-01-15T10:30:00Z",
"work_orders_count": 156
}
],
"metadata": {
"total": 25,
"page": 1,
"per_page": 20
}
}POST /clients
{
"name": "New Customer Inc",
"notes": "VIP customer - priority support"
}GET /clients/{client_id}
When creating a work order, associate it with a client:
{
"title": "Install POS System",
"client": { "id": 102 }
}Reporting: Clients enable cost rollup and reporting. All work orders tagged with a client can be filtered and analyzed together.
Last updated on