Contactos
POST
Buscar contactos
POST /api/parties/search
Descripción
Busca contactos del negocio por nombre, teléfono, documento, dirección, placa o notas.
Detalles
* Devuelve los contactos que coinciden con el texto buscado, junto con sus sub-recursos (direcciones, vehículos, repartidores, receptores de factura y proveedores). * El parámetro de contexto limita qué sub-recursos se incluyen en la respuesta; con contexto específico solo se cargan los datos de ese tipo. * Los contactos fusionados o dados de baja no aparecen en los resultados.
Permisos requeridos
auth-tenant
Request
| Nombre | Tipo | Requerido | Reglas |
|---|---|---|---|
| query | string | Sí |
min:2
max:100
|
| context | string | No |
enum:parties,addresses,vehicles,couriers,invoiceRecipients,suppliers,general
default:parties
|
Paginación
| defaultLimit | 20 |
| maxLimit | 100 |
| allowedSorts | updatedAt, createdAt |
| defaultSort | updatedAt |
| defaultDir | desc |
Ejemplo de request
curl -X POST https://app.restofy.co/api/parties/search \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <accessToken>" \
-d '{
"query": "string"
}'Los valores son demo: reemplázalos por datos reales del negocio.
Ejemplo de respuesta
Actualizado: 2026-07-15T13:20:48Z
HTTP 200
Request
{
"query": "Picapiedra"
}Response
{
"success": true,
"message": "Operación realizada correctamente",
"data": {
"parties": [
{
"id": 3,
"phone": "***",
"name": "Pedro Picapiedra",
"notes": null,
"creditType": "none",
"creditLimitCents": null,
"accountId": null,
"addresses": [],
"vehicles": [],
"couriers": [],
"invoiceRecipients": [],
"suppliers": []
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"totalPages": 1,
"hasNext": false,
"hasPrev": false
}
}
}