Sign in
Field Providers
Field API — Visits

Start a visit

Marks the visit in-progress. Idempotent: if the visit already started (or completed), returns the existing state rather than erroring.

post/api/v1/field-providers/appointments/{appointment_id}/start/

Path parameters

appointment_idstring required

Request body

triggerstring required
occurred_atstring date-time required
latitudenumber nullable
longitudenumber nullable
client_event_idstring required

Response

OK

appointment_idstring required
statusstring required
started_atstring date-time nullable
completed_atstring date-time nullable