Estás en: Documentación › Taller › Listar citas
Listar citas
Parámetros que acepta este endpoint y campos que devuelve.
GET
/v1/appointmentsPermiso necesario en la clave: appointments:read (o *).
Parámetros de ruta
Este endpoint no tiene parámetros de ruta.
Parámetros de consulta
Van en la dirección, detrás de ? y separados por &. Todos son opcionales.
| Nombre | Tipo | Obligatorio | Qué hace | Ejemplo |
|---|---|---|---|---|
status | texto (lista) | No | Estado del registro. Solo se admiten los valores de la lista. Valores: pending (pendiente), confirmed (confirmada), in_progress (en curso), completed (completada), cancelled (anulado), no_show (no se presentó).pendingconfirmedin_progresscompletedcancelledno_show | pending |
customer_id | número entero | No | Identificador del cliente (campo «id» de /customers). | 341 |
vehicle_id | número entero | No | Identificador del vehículo (campo «id» de /vehicles). | 12 |
date_from | fecha AAAA-MM-DD | No | Fecha inicial, inclusive. Formato AAAA-MM-DD. Para un trimestre: 2026-04-01. | 2026-04-01 |
date_to | fecha AAAA-MM-DD | No | Fecha final, inclusive. Formato AAAA-MM-DD. Para un trimestre: 2026-06-30. | 2026-06-30 |
updated_since | fecha y hora ISO 8601 | No | Solo registros creados o modificados desde ese momento (ISO 8601 UTC). Sirve para sincronizar solo cambios. | 2026-11-01T00:00:00Z |
limit | número entero | No | Cuántos registros devuelve cada página (1 a 100). Por defecto 25. | 50 |
page | número entero | No | Número de página, empezando en 1. Con meta.has_more = true hay más páginas. | 1 |
Campos de la respuesta
| Campo | Tipo | Qué contiene |
|---|---|---|
id | número entero | Identificador interno de la cita. |
ref | texto | Referencia de la cita. |
customer_id | número entero | Cliente. |
vehicle_id | número entero | Vehículo. |
work_order_id | número entero | Orden de trabajo asociada, si existe. |
start | fecha y hora ISO 8601 | Inicio. Fecha y hora ISO 8601 en UTC. |
end | fecha y hora ISO 8601 | Fin. Fecha y hora ISO 8601 en UTC. |
duration_min | número entero | Duración en minutos. |
service_type | texto | Tipo de servicio. |
description | texto | Descripción. |
urgent | sí / no | true si es urgente. |
resource | texto | Recurso (elevador, operario…). |
status | texto (lista) | pending, confirmed, in_progress, completed, cancelled o no_show. |
source | texto | Origen de la cita. |
created_at | fecha y hora ISO 8601 | Alta. Fecha y hora ISO 8601 en UTC. |
updated_at | fecha y hora ISO 8601 | Última modificación. Fecha y hora ISO 8601 en UTC. |