> For the complete documentation index, see [llms.txt](https://docs.adaptria.locaria.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.adaptria.locaria.com/internal-api/reference/clients.md).

# 🏢 Clients

### Clients

Browse client records. Internal-only — client API keys receive `403`. Client integrations that need their own company metadata should use the company picker endpoints under `/client/companies` instead.

## 🏢 List Clients

> List clients. Client users → only own client(s). Internal users → full list.

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🏢 Clients","description":"## Clients\n\nBrowse client records. Internal-only — client API keys receive `403`. Client integrations that need their own company metadata should use the company picker endpoints under `/client/companies` instead.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"ListClientsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"},"total":{"type":"number"},"totalPages":{"type":"number"},"hasNextPage":{"type":"boolean"},"hasPrevPage":{"type":"boolean"}},"required":["page","limit","total","totalPages","hasNextPage","hasPrevPage"]}},"required":["success","data","pagination"]}}},"paths":{"/api/public/v1/clients":{"get":{"summary":"🏢 List Clients","description":"List clients. Client users → only own client(s). Internal users → full list.","tags":["🏢 Clients"],"parameters":[{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"search","in":"query"},{"schema":{"type":"string"},"required":false,"name":"sortBy","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"required":false,"name":"sortOrder","in":"query"}],"responses":{"200":{"description":"Clients","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClientsResponse"}}}}}}}}}
```

## 🔍 Get Client Details

> Client users only see their own client; out-of-scope returns 404.

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🏢 Clients","description":"## Clients\n\nBrowse client records. Internal-only — client API keys receive `403`. Client integrations that need their own company metadata should use the company picker endpoints under `/client/companies` instead.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"ClientDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","additionalProperties":{}}},"required":["success","data"]}}},"paths":{"/api/public/v1/clients/{id}":{"get":{"summary":"🔍 Get Client Details","description":"Client users only see their own client; out-of-scope returns 404.","tags":["🏢 Clients"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Client details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDetailsResponse"}}}},"404":{"description":"Not found / out of scope"}}}}}}
```