Clients
List clients
Section titled “List clients”GET /v1/clientsReturns a paginated list of clients. Supports filtering, including custom field filters.
Success: 200 OK — (same JSON structure as Spanish docs)
Get client
Section titled “Get client”GET /v1/clients/{id}| Parameter | Type | Description |
|---|---|---|
id | string (UUID) | Client ID |
Success: 200 OK — Single Client object.
Error: 404 Not Found — { "message": "Client not found." }
Create client
Section titled “Create client”POST /v1/clients| Field | Type | Required | Description |
|---|---|---|---|
firstname | string | Yes | First name (max 255) |
lastname | string | Yes | Last name (max 255) |
email | string | Yes | Valid email (max 255) |
phone | string | Yes | International phone (max 50) |
docType | string | No | Document type (max 50) |
docNumber | string | No | Document number (max 100) |
birthdate | string | No | Birthdate (YYYY-MM-DD) |
address | string | No | Address (max 500) |
city | string | No | City (max 255) |
state | string | No | State/Province (max 255) |
country | string | No | Country (max 255) |
customFields | array | No | Custom field values |
customFields[].fieldId | string (UUID) | Yes* | Custom field UUID |
customFields[].value | string | Yes* | Field value |
*Required when sending customFields.
Success: 201 Created — { "id": "..." }
Update client
Section titled “Update client”PUT /v1/clients/{id}Body: same schema as create. All required fields must be sent.
Success: 204 No Content
Delete client
Section titled “Delete client”DELETE /v1/clients/{id}Performs a soft-delete of the client.
Success: 204 No Content