Skip to content
LabelyardLabelyardLabelyard

Get a single job

GET
/api/v1/jobs/{job_id}
curl --request GET \
  --url https://example.com/api/v1/jobs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>'

Return the full job record for the given UUID. Returns 404 if not found; for an API key without admin scope also for a job another key (or a browser, SSO user or webhook) submitted. Cancel, retry, pause and resume answer the same 404.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
job_id
required
Job Id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
JobRead

Serialised view of a Job DB row.

object
created_at
required
Created At
string
error
required
Error
Any of:
string
finished_at
required
Finished At
Any of:
string
id
required
Id
string format: uuid
payload
required
Payload
object
key
additional properties
any
printer_id
required
Printer Id
string format: uuid
result
required
Result
Any of:
object
key
additional properties
any
started_at
required
Started At
Any of:
string
state
required
State
string
template_key
required
Template Key
Any of:
string
updated_at
required
Updated At
string

Example generated

{
  "created_at": "example",
  "error": "example",
  "finished_at": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "payload": {},
  "printer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "result": {},
  "started_at": "example",
  "state": "example",
  "template_key": "example",
  "updated_at": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}