Resources
Clients
The Client resource represents a counter-party your org does business with — typically a homeowner, project owner, or MCST.
List clients
GET
/api/v1/clientsReturns clients in your org, newest first, cursor-paginated.
Supports the standard pagination query params: limit (1–100, default 50) and cursor.
terminal
curl "https://www.zengbook.com/api/v1/clients?limit=25" \
-H "Authorization: Bearer zb_live_..."200 OK
{
"data": [
{
"id": "cli_01HX...",
"name": "Tan Renovations Pte Ltd",
"email": "[email protected]",
"phone": "+65 9123 4567",
"address": "10 Anson Road, #03-01, Singapore 079903",
"notes": null,
"createdAt": "2026-05-12T03:14:22.412Z"
}
],
"hasMore": true,
"nextCursor": "eyJpZC..."
}Get a client
GET
/api/v1/clients/{id}Returns a single client. 404 if the ID does not exist in your org.
terminal
curl https://www.zengbook.com/api/v1/clients/cli_01HX... \
-H "Authorization: Bearer zb_live_..."200 OK
{
"id": "cli_01HX...",
"name": "Tan Renovations Pte Ltd",
"email": "[email protected]",
"phone": "+65 9123 4567",
"address": "10 Anson Road, #03-01, Singapore 079903",
"notes": null,
"createdAt": "2026-05-12T03:14:22.412Z"
}Fields
| Field | Type | Notes |
|---|---|---|
| id | string | Prefix cli_. |
| name | string | Display name. |
| string | null | Primary contact email. | |
| phone | string | null | Free-form phone string. |
| address | string | null | Free-form postal address. |
| notes | string | null | Internal notes. |
| createdAt | string | ISO 8601 UTC timestamp. |
Related webhook events
client.created— fires when a client is added in-app or via integration. See the event reference.