Skip to main content
Visits

List visits

GET
/visits
Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

limitintegerquerydefault:25
Required range: 1 <= x <= 100
cursorstringquery
include_totalenum<string>querydefault:false

When true, total is a full count of matching records and costs an extra query. Otherwise total is null.

Available options: true, false
job_idstringquery
customer_idstringquery
user_idstringquery
crew_idintegerquery
Required range: 0 < x
statusstringquery
start_datestringquery
end_datestringquery

Response

application/json

A page of visits, latest start first

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

dataobject[]required
has_morebooleanrequired
next_cursorstring | nullrequired
previous_cursorstring | nullrequired
totalinteger | nullrequired

Null unless include_total=true.

Required range: 0 <= x