API Reference
Clients
Manage the client records in your ComplyPost organisation. Clients are linked to registered addresses and receive letters routed to them automatically.
GET
/clientsList all clients for your organisation with pagination.
Auth: Bearer token
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number (default: 1) |
| limit | integer | Results per page (default: 20, max: 100) |
| search | string | Search by name, company number, or email |
GET
/clients/:idGet a single client record including address and contact details.
Auth: Bearer token
POST
/clientsCreate a new client record.
Auth: Bearer token
| Parameter | Type | Description |
|---|---|---|
| name | string | Client or company name (required) |
| companyNumber | string | Companies House registration number |
| string | Primary contact email for delivery | |
| registeredAddress | string | Registered office address |
PATCH
/clients/:idUpdate an existing client record. Only send fields you want to change.
Auth: Bearer token
| Parameter | Type | Description |
|---|---|---|
| name | string | Updated client name |
| string | Updated delivery email | |
| registeredAddress | string | Updated registered address |
DELETE
/clients/:idDelete a client and all associated data. This action is irreversible.
Auth: Bearer token