Zum Inhalt springen
LabelyardLabelyardLabelyard

List jobs

GET
/api/v1/jobs
curl --request GET \
  --url 'https://example.com/api/v1/jobs?limit=50' \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>'

Returns jobs matching the optional filters, ordered by creation time. state accepts any valid JobState value (queued, printing, done, failed, cancelled, failed_restart). since is an ISO-8601 datetime; only jobs created at or after that instant are returned. limit caps the result (default 50, max 200). An API key without admin scope, and a browser session signed in with one, sees only the jobs that key submitted; SSO users and admin keys see every job of their printers.

Authorizations

Abschnitt betitelt „Authorizations“

Parameters

Abschnitt betitelt „Parameters“

Query Parameters

Abschnitt betitelt „Query Parameters“
state
State

Filter by job state (queued / printing / done / failed / …)

Any of:
string

Filter by job state (queued / printing / done / failed / …)

printer_id
Printer Id

Filter by printer UUID

Any of:
string format: uuid

Filter by printer UUID

since
Since

Return only jobs created at or after this ISO-8601 datetime

Any of:
string format: date-time

Return only jobs created at or after this ISO-8601 datetime

limit
Limit

Maximum number of jobs to return (1-200, default 50)

integer
default: 50 >= 1 <= 200

Maximum number of jobs to return (1-200, default 50)

Responses

Abschnitt betitelt „Responses“

200

Abschnitt betitelt „200“

Successful Response

Media typeapplication/json
Response List Jobs Api V1 Jobs Get
Array<object>
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

Abschnitt betitelt „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"
    }
  ]
}