Consultar citas por paciente y rango
GET
/appointmentsLista citas visibles para el tenant autenticado. Se exige patientId para evitar extracciones masivas; el intervalo es semiabierto y maximo de 366 dias.
curl --request GET \
--url '${BASE_URL}/appointments' \
--header 'Authorization: Bearer ${ACCESS_TOKEN}' \
--header 'X-Correlation-Id: 10000000-0000-4000-8000-000000000007' \
--data-urlencode 'patientId=20000000-0000-4000-8000-000000000001' \
--data-urlencode 'from=2026-08-01T00:00:00-05:00' \
--data-urlencode 'to=2026-09-01T00:00:00-05:00'Request
Headers y parametros
| Nombre | Ubicacion | Requerido | Descripcion |
|---|---|---|---|
X-Correlation-Id | header | No | UUID generado por el consumidor para trazabilidad; el servidor genera uno si se omite. |
patientId | query | Si | Identificador opaco del paciente dentro del tenant autenticado. |
from | query | Si | Inicio inclusivo del rango. |
to | query | Si | Fin exclusivo del rango. |
status | query | No | Estado operativo opcional. |
cursor | query | No | Cursor opaco retornado por la pagina anterior; no debe interpretarse. |
limit | query | No | Cantidad maxima de elementos solicitados. |
Responses
200Pagina ordenada por fecha de inicio ascendente.
Content-Type: application/json
| Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
items | object[] | Si | - |
nextCursor | string | null | Si | - |
Ejemplo
{
"items": [
{
"endsAt": "2026-08-03T09:30:00-05:00",
"id": "60000000-0000-4000-8000-000000000001",
"patientId": "20000000-0000-4000-8000-000000000001",
"serviceId": "30000000-0000-4000-8000-000000000003",
"startsAt": "2026-08-03T09:00:00-05:00",
"status": "PENDING",
"version": 1
}
],
"nextCursor": null
}400Solicitud mal formada o parametro invalido.
Content-Type: application/problem+json
| Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
code | string | Si | - |
correlationId | string (uuid) | Si | - |
detail | string | No | Explicacion segura sin PII ni secretos. |
errors | object[] | No | - |
instance | string (uri-reference) | No | - |
status | integer | Si | - |
title | string | Si | - |
type | string (uri) | Si | URI estable que identifica la clase de problema. |
Ejemplo
{
"code": "INVALID_REQUEST",
"correlationId": "10000000-0000-4000-8000-000000000001",
"detail": "Revise los parametros enviados.",
"status": 400,
"title": "Solicitud invalida",
"type": "https://magnosoft.com.co/problems/invalid-request"
}401Token ausente, invalido, vencido o con audience incorrecta.
Content-Type: application/problem+json
| Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
code | string | Si | - |
correlationId | string (uuid) | Si | - |
detail | string | No | Explicacion segura sin PII ni secretos. |
errors | object[] | No | - |
instance | string (uri-reference) | No | - |
status | integer | Si | - |
title | string | Si | - |
type | string (uri) | Si | URI estable que identifica la clase de problema. |
Ejemplo
{
"code": "INVALID_ACCESS_TOKEN",
"correlationId": "10000000-0000-4000-8000-000000000001",
"status": 401,
"title": "Autenticacion requerida",
"type": "https://magnosoft.com.co/problems/unauthorized"
}403Service principal autenticado sin el scope requerido.
Content-Type: application/problem+json
| Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
code | string | Si | - |
correlationId | string (uuid) | Si | - |
detail | string | No | Explicacion segura sin PII ni secretos. |
errors | object[] | No | - |
instance | string (uri-reference) | No | - |
status | integer | Si | - |
title | string | Si | - |
type | string (uri) | Si | URI estable que identifica la clase de problema. |
Ejemplo
{
"code": "INSUFFICIENT_SCOPE",
"correlationId": "10000000-0000-4000-8000-000000000001",
"status": 403,
"title": "Permiso insuficiente",
"type": "https://magnosoft.com.co/problems/forbidden"
}429Limite de solicitudes excedido para el service principal.
Content-Type: application/problem+json
| Campo | Tipo | Requerido | Descripcion |
|---|---|---|---|
code | string | Si | - |
correlationId | string (uuid) | Si | - |
detail | string | No | Explicacion segura sin PII ni secretos. |
errors | object[] | No | - |
instance | string (uri-reference) | No | - |
status | integer | Si | - |
title | string | Si | - |
type | string (uri) | Si | URI estable que identifica la clase de problema. |
Ejemplo
{
"code": "RATE_LIMIT_EXCEEDED",
"correlationId": "10000000-0000-4000-8000-000000000001",
"status": 429,
"title": "Demasiadas solicitudes",
"type": "https://magnosoft.com.co/problems/rate-limit"
}