Listar repartidores — Restofy Docs

Descripción

Listado paginado de repartidores del directorio.

Detalles

* Devuelve los repartidores con paginación y búsqueda por nombre. * Incluye el teléfono y la plataforma de reparto asociada a cada repartidor. * El nombre se resuelve desde el contacto vinculado cuando existe; si no, usa el nombre propio del repartidor.

Permisos requeridos

parties.module

Request

Nombre	Tipo	Requerido	Reglas
search	string	No	max:100

Paginación

defaultLimit	50
maxLimit	100
defaultDir	asc
withTotal	true
allowedSorts	[name, platform]

Ejemplo de request

curl -X POST https://app.restofy.co/api/parties/list-couriers-admin \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>"

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

Ejemplo de respuesta

Actualizado: 2026-07-15T13:20:48Z

HTTP 200

Request

[]

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "couriers": [
            {
                "courierId": 1,
                "courierUuid": "8227621d-7eb3-11f1-ac02-f2368af4d8ac",
                "partyId": null,
                "name": "Mensajero Test",
                "phone": "***",
                "platform": "rappi",
                "isAvailable": 1
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 50,
            "total": 1,
            "totalPages": 1,
            "hasNext": false,
            "hasPrev": false
        }
    }
}