Skip to content

Clients

GET /v1/clients

Returns a paginated list of clients. Supports filtering, including custom field filters.

Success: 200 OK — (same JSON structure as Spanish docs)

GET /v1/clients/{id}
ParameterTypeDescription
idstring (UUID)Client ID

Success: 200 OK — Single Client object.

Error: 404 Not Found{ "message": "Client not found." }

POST /v1/clients
FieldTypeRequiredDescription
firstnamestringYesFirst name (max 255)
lastnamestringYesLast name (max 255)
emailstringYesValid email (max 255)
phonestringYesInternational phone (max 50)
docTypestringNoDocument type (max 50)
docNumberstringNoDocument number (max 100)
birthdatestringNoBirthdate (YYYY-MM-DD)
addressstringNoAddress (max 500)
citystringNoCity (max 255)
statestringNoState/Province (max 255)
countrystringNoCountry (max 255)
customFieldsarrayNoCustom field values
customFields[].fieldIdstring (UUID)Yes*Custom field UUID
customFields[].valuestringYes*Field value

*Required when sending customFields.

Success: 201 Created{ "id": "..." }

PUT /v1/clients/{id}

Body: same schema as create. All required fields must be sent.

Success: 204 No Content

DELETE /v1/clients/{id}

Performs a soft-delete of the client.

Success: 204 No Content