Clients API
Read and manage client records through the public `/clients` API.
The public client API is:
/clientsThe product term is Clients, and that is the resource documented here.
Client Object Shape
The documented response fields include:
{
"id": "cli_123",
"name": "Northwind Advisory",
"email": "[email protected]",
"phone": "+1-555-0100",
"address": "1 Market St",
"website": "https://northwind.example",
"taxId": "US-123456",
"notes": "Primary billing contact is Dana",
"userId": "usr_123",
"createdAt": "2026-03-01T10:00:00.000Z",
"updatedAt": "2026-03-01T10:00:00.000Z"
}Endpoints
| Method | Path | Purpose |
|---|---|---|
GET | /clients | list clients |
POST | /clients | create a client |
GET | /clients/{id} | fetch one client |
PATCH | /clients/{id} | update a client |
DELETE | /clients/{id} | delete a client |
Create Example
curl -X POST https://api.conduitt.io/clients \
-H "Authorization: Bearer ck_test_your_key" \
-H "Content-Type: application/json" \
-d '{
"name": "Northwind Advisory",
"email": "[email protected]",
"phone": "+1-555-0100",
"address": "1 Market St",
"website": "https://northwind.example",
"taxId": "US-123456",
"notes": "Primary billing contact is Dana"
}'Listing and Search
GET /clients supports:
- offset pagination by default
- cursor pagination when
pagination=cursor - text search with
q
See Pagination for the response shapes.