API reference
3 operations in dispatch-connector. Raw spec: openapi.json.
POST
/api/v1/dispatch-connector/appointments/{id}/statusPOST /api/dispatch-connector/appointments/{id}/status — push one field-service status update. Idempotent via the instant envelope: the same key + payload replays the same stored row (never double-pushes); a foreign-org appointment id is a bare 404.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes |
Request body
PushStatusRequest
Responses
| Status | Description |
|---|---|
201 | |
404 | appointment not visible in scope |
409 | idempotency key reused with a different payload |
422 | unknown status vocabulary |
429 | rate limit exceeded (Retry-After header) |
Security: bearer, api_key
GET
/api/v1/dispatch-connector/scheduleGET /api/dispatch-connector/schedule — bookings in a bounded window with technician/ticket/client coordinates and the latest pushed field-service status per booking.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
from | query | — | No | |
days | query | — | No | Window length in days (1..=62, default 7). |
Responses
| Status | Description |
|---|---|
200 | |
403 | missing dispatch:read scope (keys) or not an org admin (humans) |
Security: bearer, api_key
GET
/api/v1/dispatch-connector/techniciansGET /api/dispatch-connector/technicians — active technicians with their current (non-expired) skills.
Responses
| Status | Description |
|---|---|
200 | |
403 | missing dispatch:read scope (keys) or not an org admin (humans) |
Security: bearer, api_key