Skip to main content
GET
List jobs

Authorizations

API-Key
string
header
required

Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.

Query Parameters

id
string

Only this job.

externalId
string

Only the job with this externalId. No match returns an empty list with totalCount 0.

date
string<date>

Day of the jobs, YYYY-MM-DD. An empty value lists jobs without a date. Default: today in the day list, all dates in the paged list.

allDates
boolean
default:false

Search across all dates (used with text).

assigneeId
string

Only jobs of this member. An empty value lists unassigned jobs. Not together with assigneeUsername.

assigneeUsername
string

Only jobs of the member with this username. An empty value lists unassigned jobs. Not together with assigneeId.

progress
enum<string>

Only jobs in this progress state. Switches to the paged list. Derived from the job's timestamps: success when completed, failed when marked failed, in_progress when accepted and checked in, accepted when accepted, unassigned when nobody is assigned, otherwise scheduled (assigned, not yet accepted).

Available options:
unassigned,
scheduled,
accepted,
in_progress,
success,
failed
text
string

Case-insensitive search in title, address and notes; also matches a job id, an order number or a job group name.

createdSince
integer<int64>

ms timestamp: only jobs created at or after it, newest created first. Switches to the paged list.

updatedSince
integer<int64>

ms timestamp: only jobs saved at or after it. Switches to the paged list.

includeArchived
boolean
default:false

Include archived jobs.

limit
integer
default:100

Page size of the paged list. Switches to the paged list.

Required range: x >= 0
skip
integer
default:0

Jobs to skip in the paged list. Switches to the paged list.

Required range: x >= 0

Response

Success

data
object
required
error
null
required
meta
object
required