Clients API
List clients
Retrieve all clients for your organization.
GET /api/clients Response
[
{
"id": "uuid",
"name": "Summit Physical Therapy",
"industry": "Healthcare",
"website": "summitpt.com",
"created_at": "2026-01-15T10:30:00Z",
"locations_count": 12
}
] Create a client
Add a new client to your organization. Requires Admin role.
POST /api/clients
Content-Type: application/json
{
"name": "Summit Physical Therapy",
"industry": "Healthcare",
"website": "summitpt.com"
} Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Client/brand name |
industry | string | No | Industry category |
website | string | No | Client's primary domain |
Response
{
"id": "uuid",
"name": "Summit Physical Therapy"
} Delete a client
Remove a client and all associated data. Requires Admin role. This action is permanent and cannot be undone.
DELETE /api/clients/:clientId Response
{
"success": true
} Error responses
| Status | Meaning |
|---|---|
400 | Missing required fields (e.g., client name) |
401 | Not authenticated |
403 | Insufficient permissions (not an Admin) |
500 | Server error |