R
Rankup

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

FieldTypeRequiredDescription
namestringYesClient/brand name
industrystringNoIndustry category
websitestringNoClient'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

StatusMeaning
400Missing required fields (e.g., client name)
401Not authenticated
403Insufficient permissions (not an Admin)
500Server error