Skip to content
PaprikaPaprikaPaprika

The tenant's jobs, newest first, a page at a time

GET
/v1/jobs
curl --request GET \
  --url 'https://example.com/v1/jobs?status=queued' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
>= 1 <= 200

At most this many (1 to 200, 50 by default).

cursor
string

The page after the one whose next this is.

status
string
Allowed values: queued running done failed cancelled

Only jobs of this status.

template
string

Only jobs of this template.

Responses

Section titled “Responses”

200

Section titled “200”

The answer.

Media typeapplication/json
object
items
required
Array<object>
object
id
string
status
required
string
template
string
version
integer
format
string
attempts
required
integer
createdAt
required
string
startedAt
required
null | string
finishedAt
required
null | string
queue
object
record
integer
job
string
output
object
next
required

Example generated

{
  "items": [
    {
      "id": "example",
      "status": "example",
      "template": "example",
      "version": 1,
      "format": "example",
      "attempts": 1,
      "createdAt": "example",
      "startedAt": "example",
      "finishedAt": "example",
      "queue": {},
      "record": 1,
      "job": "example",
      "output": {}
    }
  ],
  "next": "example"
}

401

Section titled “401”

No key, or not a valid one.

Media typeapplication/json
object
code
required
string
Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing
message
required
string
requestId
string

Example 

{
  "code": "field-unknown"
}

403

Section titled “403”

The key lacks the scope, or its tenant is suspended or deleted.

Media typeapplication/json
object
code
required
string
Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing
message
required
string
requestId
string

Example 

{
  "code": "field-unknown"
}