Skip to main content
Jobs

Get a job

GET
/jobs/{id}
Authorizationstringheaderrequired

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

idstringrequired
expandstringquery

Response

application/json

The job

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).

amount_receivednumberrequired
balance_duenumberrequired
completed_atstring | nullrequired
created_atstring | nullrequired
customerobject | nullrequired
discountsobject[]required
first_visitobject | nullrequired

Start and end of the first visit; null when none is scheduled.

idstringrequired
in_progress_atstring | nullrequired
job_numberstring | nullrequired
line_itemsobject[]required
property_addressobjectrequired
sequenceinteger | nullrequired
service_plan_idstring | nullrequired

Null for one-time jobs.

statusenum<string>required
Available options: Unscheduled, Pending, Scheduled, In Progress, Completed, Cancelled
techniciansobject[]required
totalnumberrequired
updated_atstring | nullrequired
visit_idsinteger[]required
visitsobject[]