Saltar al contenido principal

Consultar el detalle de una cita

GET/appointments/{appointmentId}

Obtiene el estado y horario vigente de una cita del tenant autenticado. No retorna documento, telefono, notas clinicas ni timeline interno.

curl --request GET \
  --url '${BASE_URL}/appointments/60000000-0000-4000-8000-000000000001' \
  --header 'Authorization: Bearer ${ACCESS_TOKEN}' \
  --header 'X-Correlation-Id: 10000000-0000-4000-8000-000000000009'

Request

Headers y parametros

NombreUbicacionRequeridoDescripcion
appointmentIdpathSiIdentificador opaco de la cita dentro del tenant autenticado.
X-Correlation-IdheaderNoUUID generado por el consumidor para trazabilidad; el servidor genera uno si se omite.

Responses

200Detalle externo de la cita.

Content-Type: application/json

CampoTipoRequeridoDescripcion
endsAtstring (date-time)Si-
idstring (uuid)Si-
patientIdstring (uuid)Si-
serviceIdstring (uuid)Si-
startsAtstring (date-time)Si-
statusstringSiPENDING, CONFIRMED, CHECKED_IN, ATTENDED, CANCELLED, NO_SHOW
versionintegerSi-

Ejemplo

ejemplo de respuesta 200
{
  "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
}
400Solicitud mal formada o parametro invalido.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 400
{
  "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

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 401
{
  "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

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 403
{
  "code": "INSUFFICIENT_SCOPE",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 403,
  "title": "Permiso insuficiente",
  "type": "https://magnosoft.com.co/problems/forbidden"
}
404Recurso inexistente o no visible dentro del tenant autenticado.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 404
{
  "code": "RESOURCE_NOT_FOUND",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 404,
  "title": "Recurso no encontrado",
  "type": "https://magnosoft.com.co/problems/not-found"
}
429Limite de solicitudes excedido para el service principal.

Content-Type: application/problem+json

CampoTipoRequeridoDescripcion
codestringSi-
correlationIdstring (uuid)Si-
detailstringNoExplicacion segura sin PII ni secretos.
errorsobject[]No-
instancestring (uri-reference)No-
statusintegerSi-
titlestringSi-
typestring (uri)SiURI estable que identifica la clase de problema.

Ejemplo

ejemplo de respuesta 429
{
  "code": "RATE_LIMIT_EXCEEDED",
  "correlationId": "10000000-0000-4000-8000-000000000001",
  "status": 429,
  "title": "Demasiadas solicitudes",
  "type": "https://magnosoft.com.co/problems/rate-limit"
}