Listar citas

GEThttps://api.bydomu.com/v1/appointments

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Citas de la organización ordenadas por hora de inicio (sortOrder, por defecto de la más lejana a la más cercana), con filtros por estado, tipo, responsable, contacto y rango de fechas (pageSize máximo 500).

Permissão

appointments:read

Chaves

Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório

Sua chave secreta.

Parâmetros de consulta

pageinteger

Página, desde 1 · default=1 · ≥ 1

pageSizeinteger

Citas por página (máximo 500) · default=20 · 1–500

cursorstring

Se valida pero no se aplica en esta operación

includeTotalboolean | string

Se valida pero no se aplica en esta operación

sortBystring

Se valida pero no se aplica en esta operación: siempre se ordena por startTime · default="createdAt"

sortOrderstring

Orden por hora de inicio ascdesc · default="desc"

searchstring

Se valida pero no se aplica en esta operación

statusstring

Estado de la cita SCHEDULEDCONFIRMEDCOMPLETEDCANCELLEDNO_SHOW

typestring

Tipo de cita SHOWINGMEETINGCALLFOLLOW_UPSIGNINGOTHER

assigneeIdstring

Responsable

contactIdstring

Contacto

dealIdstring

Se valida pero no se aplica en esta operación

dateFromstring

Empiezan desde esta fecha (ISO 8601) · nullable

dateTostring

Empiezan hasta esta fecha (ISO 8601) · nullable

Respostas

200Página de citas

400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.

401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.

403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.

429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.

500INTERNAL_ERROR · Error interno del servidor.

{ "data": [ { "id": "clx1apt001", "title": "Visita Apto Chapinero", "description": "Segunda visita; llevar el certificado de libertad.", "type": "SHOWING", "status": "SCHEDULED", "startTime": "2026-10-02T15:00:00.000Z", "endTime": "2026-10-02T16:00:00.000Z", "color": "#6366F1", "location": "Cra 7 #45-12, Bogotá", "createdAt": "2026-09-25T09:00:00.000Z", "contact": { "id": "clx1con001", "firstName": "María", "lastName": "González", "phone": "+573001234567" }, "deal": { "id": "clx1deal001", "title": "Venta Apto Chapinero" }, "property": { "id": "clx1prop001", "title": "Apartamento en Chapinero con vista", "city": "Bogotá" }, "assignee": { "id": "clx1usr001", "firstName": "Carlos", "lastName": "Rodríguez" } } ], "meta": { "total": 150, "page": 1, "pageSize": 20, "totalPages": 8 } }