API Reference
Clients API
API reference for reading client data via the Dime.Sheets public API.
Clients API
The Clients public API provides read-only access to client records.
List clients
GET /api/v1/clientsReturns all clients in the tenant.
curl "https://app.dimesheets.com/api/v1/clients" \
-H "X-API-KEY: {your-api-key}"Example response
[
{
"id": 1,
"externalId": "client-acme",
"tenantId": "tenant-abc",
"name": "Acme Corp",
"contactEmail": "[email protected]",
"contactPhone": "+1-555-0100",
"address": "123 Main St, New York, NY",
"currency": "USD",
"isActive": true,
"createdAt": "2026-01-15T10:00:00Z",
"updatedAt": "2026-03-20T08:45:00Z"
}
]Get a client
GET /api/v1/clients/{externalId}Returns the client matching the given external ID, or 404 Not Found.
Client model
| Field | Type | Description |
|---|---|---|
id | int | Internal ID |
externalId | string | Stable external identifier |
tenantId | string | Tenant ID |
name | string | Client name |
contactEmail | string? | Primary contact email |
contactPhone | string? | Primary contact phone |
address | string? | Address |
currency | string? | Preferred currency (ISO 4217) |
isActive | boolean | Whether the client is active |
createdAt | datetime | Creation timestamp |
updatedAt | datetime | Last update timestamp |