Restofy Docs
Contactos del negocio POST

Buscar contacto por teléfono exacto

POST /api/parties/get-party-by-phone

Descripción

Devuelve el contacto cuyo teléfono coincide exactamente con el indicado.

Detalles

* Busca un contacto por coincidencia exacta del número de teléfono. * Si lo encuentra, retorna el contacto con todos sus sub-recursos (direcciones, vehículos, repartidores, receptores de factura y proveedores). * Si no existe ningún contacto con ese teléfono, la respuesta viene vacía.

Permisos requeridos

auth-tenant

Request

Nombre Tipo Requerido Reglas
phone string
min:5 max:30

Ejemplo de request

curl -X POST https://restofy.pro/api/parties/get-party-by-phone \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>" \
  -H "X-Tenant-Key: <tenantKey>" \
  -d '{
    "phone": "string"
}'

Los valores son demo: reemplázalos por datos reales del negocio.

Ejemplo de respuesta

Actualizado: 2026-09-08T16:35:34Z
HTTP 200

Request

{
    "phone": "***"
}

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "party": {
            "id": 3,
            "phone": "***",
            "name": "Juan Pérez",
            "notes": null,
            "creditType": "none",
            "creditLimitCents": null,
            "accountId": null,
            "addresses": [
                {
                    "id": 1,
                    "partyId": 3,
                    "label": null,
                    "addressLine": "Calle 45 #12-34",
                    "addressDetail": "Apto 302, torre B",
                    "addressReference": "Portón verde",
                    "city": "Bogotá",
                    "state": null,
                    "countryCode": null,
                    "postalCode": null,
                    "latitude": null,
                    "longitude": null,
                    "notes": null,
                    "isDefault": 1
                }
            ],
            "vehicles": [],
            "couriers": [],
            "invoiceRecipients": [],
            "suppliers": []
        }
    }
}