API Reference
  1. Viv Public API
  2. Visits

List visits

get
https://{apiHost}/api/v2/public/visits

Retrieve a paginated list of scheduled and completed visits (bookings).
Supports filtering by date range, client, caregiver, and status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 20

Maximum number of results to return (1-100)

integer
≥ 0
Defaults to 0

Number of results to skip for pagination

date-time

Return only records updated after this timestamp (ISO 8601)

date

Filter visits starting on or after this date (YYYY-MM-DD)

date

Filter visits starting on or before this date (YYYY-MM-DD)

string

Filter by client ID

string

Filter by caregiver ID

string
enum

Filter by visit status. Case-insensitive.

  • scheduled: Future visits not yet checked in
  • open: Visits without a caregiver assigned
  • in_progress: Checked in but not checked out
  • completed: Both checked in and checked out
  • cancelled: Cancelled visits
  • missed: Past end time with no check-in
Allowed:
string

Filter by geographic location ID

string

Filter by booking type ID (service type)

string

Filter by recurrence ID (booking set)

boolean

Filter by cancellation status

boolean

Filter by check-in status. true returns visits with successful check-in, false returns visits without check-in.

boolean

Filter by check-out status. true returns visits with successful check-out, false returns visits without check-out.

boolean

Filter by lock status. true returns visits locked for payroll, billing, or deletion.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?