v1

latestOpenAPI 3.1.02026-07-24730265.7 KB

List Jobs

get/api/v3/jobs

Query parameters

searchstring

Returns job with matching search parameter across job name, address, or user. Minimum Three characters are required.

archivedboolean

Default is false. When true, only archived jobs are returned.

exampleboolean

Default is false. When true, only example jobs are returned.

sort_orderstring

Defaults to DESC Allowed values are ASC or DESC.

sort_bystring

Sorts jobs by timestamp and used with the sort_order parameter. Allowed values are completed_at, created_at, or updated_at.

updated_sincestring

Seconds since the EPOCH. Only return jobs that have been updated since this time.

perinteger

Default is 25 results. The response body can include up to 100 jobs.

pageinteger

Used to paginate through results. This parameter indicates which page to return.

deliverable_ids[]integer[]

Returns jobs with models of the selected deliverable type, 1, 2, 3, 5, 6, 8.

reconstruction_states[]string

Returns jobs of the supplied reconstruction state, "failed" or "completed". Reconstruction state indicates all the models on the job have been processed by Hover and at least one succeeded. The models on the jobs may be a mix of failed and completed states.

Response

200

object required