List visits
/v1/visitsReturns a page of visits, ordered by scheduled start, earliest first. Filters combine with AND. Use next_cursor to fetch the next page.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Start of the window (inclusive), ISO 8601 with a time zone. Visits are listed by scheduled start. Both start_from and start_to are required, and the window can be at most 93 days.
End of the window (exclusive), ISO 8601 with a time zone. At most 93 days after start_from.
Only return visits for this patient.
Only return visits assigned to this caregiver.
Only return visits with this status.
ScheduledInProgressCancelledCompletedLateOverTimeIncompleteOnly return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The visits on this page.
Show item attributesHide item attributes(27)
String representing the object's type. Always visit.
Unique identifier of the visit.
The patient being visited.
The caregiver assigned to the visit; null for an open shift.
Scheduled start.
Scheduled end.
Where the visit is in its day. New visits are Scheduled.
ScheduledInProgressCancelledCompletedLateOverTimeIncompletenullShort title shown on the schedule.
Whether the visit spans the whole day, such as a live-in shift.
Tasks the caregiver should complete during the visit.
Why the visit is scheduled, if it is not routine.
Notes for the caregiver about this visit.
Billing service code for the visit.
Where the visit takes place, when it is not the patient's home address.
When the caregiver clocked in.
When the caregiver clocked out.
Tasks the caregiver marked done.
Whether the visit passed electronic visit verification.
Electronic visit verification status.
PendingValidatedFlaggedOverriddenExportedSubmittednullWhether the visit has been billed.
NotBilledPendingInvoicedPaidnullThe invoice the visit was billed on.
Hours billed for the visit.
Whether the visit belongs to a repeating series.
The repeating series the visit belongs to.
The caregiver's response to the assignment.
confirmeddeclinednullWhen the visit was created.
When the visit was last changed.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.