List appointments
GET /appointments
Lists CRM appointments through the active connector. Supply both startDate and endDate in YYYY-MM-DD form or neither; when omitted, the connector chooses its default range. The range, mineOnly, and forceSync parameters sent by older browser clients are ignored. Connector-level failures can return HTTP 200 with successful: false.
Operation ID: getAppointments
Authorization: BEARER or API key
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
range |
query | object of any | No | Ignored browser-client compatibility object. Use startDate and endDate; the current server does not read range. |
mineOnly |
query | boolean | No | Ignored browser-client compatibility flag. The current HTTP route does not filter appointments by owner. |
forceSync |
query | boolean | No | Ignored browser-client compatibility flag. The current HTTP route does not expose a force-synchronization option. |
startDate |
query | string · date | No | Inclusive appointment start date. Supply together with endDate. |
endDate |
query | string · date | No | Inclusive appointment end date. Supply together with startDate. |
Responses
| Status | Description | Body |
|---|---|---|
200 |
Appointments returned by the active connector. | AppointmentListResponse |
400 |
Bad request, missing authentication, or connector error. | ErrorResponse, string |
401 |
The user session is expired or revoked. | ErrorResponse, string |