Solicitar demo

Dispatchers API

Listar riders del dispatcher

Devuelve el catálogo de riders asociados al dispatcher autenticado, incluyendo presencia online y última ubicación vigente si existe.

Volver a todos los endpoints

Dispatchers API

Listar riders del dispatcher

Usa este endpoint para sincronizar o consultar los riders que pertenecen al dispatcher autenticado. No requiere query params ni body.

GET /api/dispatchers/me/riders 200 OK
Auth requerida Perfil: dispatcher

Campos principales

Resumen de los campos relevantes para este endpoint.

Campo Tipo Descripción
riderId string Identificador del rider devuelto por Operio.
name string Nombre visible del rider.
email string Email asociado al rider.
allowRestaurantAreaPool boolean Indica si el rider puede entrar en pools de área de restaurante.
vehicleType string Tipo de vehículo configurado para el rider.
autoAssignmentEnabled boolean Indica si el rider puede recibir autoasignaciones.
maxAutoAssignmentPickupDistanceKm number | null Distancia máxima de recogida considerada para autoasignación.
maxAutoAssignmentRouteDistanceKm number | null Distancia máxima de ruta considerada para autoasignación.
isOnline boolean Indica si el rider está online según la presencia vigente.
currentLocation object | null Última ubicación vigente del rider: lat, lng, heading, speed y accuracy.
lastLocationUpdatedAt string | null Fecha ISO de la última ubicación vigente, si existe.
createdAt string Fecha ISO de creación del rider.
updatedAt string Fecha ISO de última actualización del rider.

Request cURL

curl -X GET 'https://api.deliveryforall.com/api/dispatchers/me/riders' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Respuesta 200

{
  "data": [
    {
      "riderId": "rider_8c385706",
      "name": "Carlos Perez",
      "email": "carlos@example.com",
      "allowRestaurantAreaPool": false,
      "vehicleType": "motorcycle",
      "autoAssignmentEnabled": true,
      "maxAutoAssignmentPickupDistanceKm": 6,
      "maxAutoAssignmentRouteDistanceKm": 12,
      "isOnline": true,
      "currentLocation": {
        "lat": 38.346158,
        "lng": -0.510089,
        "heading": 90,
        "speed": 7.2,
        "accuracy": 5
      },
      "lastLocationUpdatedAt": "2026-06-16T10:29:59.000Z",
      "createdAt": "2026-02-25T12:00:00.000Z",
      "updatedAt": "2026-06-16T10:30:00.000Z"
    }
  ]
}

Consola de prueba

Envía una petición de prueba

Ajusta la URL base, pega tu token y prueba la consulta desde esta página. También puedes copiar el ejemplo como cURL o JavaScript.

La respuesta aparecerá aquí.

Errores esperados

Respuestas habituales que debe contemplar la integración.

401
AUTH_MISSING_TOKEN

Token requerido

No se ha enviado token en Authorization ni x-api-token.

401
AUTH_INVALID_AUTHORIZATION_HEADER

Cabecera Authorization inválida

La cabecera Authorization no tiene un formato válido.

401
AUTH_INVALID_TOKEN

Token inválido

Token inexistente, expirado o no resoluble.

401
DISPATCHER_LIST_RIDERS_UNAUTHORIZED

Usuario no autenticado

La ruta llega sin usuario autenticado tras el middleware. Es un caso defensivo.

403
AUTH_DISPATCHER_ROLE_REQUIRED

Rol dispatcher requerido

La cuenta autenticada no tiene rol dispatcher.

429
RATE_LIMIT_EXCEEDED

Too Many Requests

Más de 3 peticiones por minuto a esta ruta para la misma IP o identidad.

500
AUTH_TOKEN_VALIDATION_FAILED

Fallo validando token

Fallo consultando el token del usuario durante autenticación.

500
AUTH_RESTAURANT_MEMBERSHIPS_READ_FAILED

Fallo leyendo membresías

Fallo leyendo membresías de restaurante durante autenticación.

500
AUTH_DISPATCHER_ROLE_VALIDATION_FAILED

Fallo validando rol dispatcher

Fallo validando el rol dispatcher del usuario autenticado.

500
DISPATCHER_LIST_RIDERS_REPOSITORY_READ_FAILED

Fallo leyendo riders

Fallo leyendo riders asociados al dispatcher.

500
DISPATCHER_LIST_RIDERS_PROFILE_READ_FAILED

Fallo leyendo perfiles

Fallo leyendo perfiles de usuario de los riders.

500
DISPATCHER_LIST_RIDERS_FAILED

Fallo no clasificado

Fallo no clasificado al listar riders.

Ejemplo de error

{
  "error": {
    "code": "DISPATCHER_LIST_RIDERS_REPOSITORY_READ_FAILED",
    "message": "Could not list riders for dispatcher: <detalle>"
  }
}