List render jobs for a deploy

GET

/v1/render-jobs

curl --request GET \
  --url 'https://api.presscloud.example/v1/render-jobs?deployId=example' \
  --header 'Authorization: Bearer <token>'

Returns recent render jobs for a deploy.

Authorizations

• bearerAuth

Parameters

Query Parameters

deployId

required

string

>= 1 characters

Selects the deploy that owns the render job.

limit

integer

>= 1 <= 50

Maximum number of render jobs to return. Defaults to 20.

cursor

string

>= 1 characters

Opaque cursor returned by a previous render jobs list response.

Responses

200

Render jobs list.

Media type application/json

object

items

required

Array<object>

object

job

required

object

id

required

string

>= 1 characters

deployId

required

string

deployVersionId

required

string

deployVersionNo

integer

deployVersionRoute

string

deployVersionTitle

string

businessKey

required

string

payloadHash

required

string

status

required

string

Allowed values: queued rendering succeeded retry_scheduled failed canceled

attempt

required

integer

requestedAt

required

integer

startedAt

integer

finishedAt

integer

errorCode

string

errorMessage

string

outputMode

required

string

Allowed values: transient managed

output

object

id

required

string

renderJobId

required

string

pdfBlobHash

string

pdfR2Key

string

bytes

required

integer

pageCount

integer

>= 1

timingJson

string

createdAt

required

integer

state

required

string

Allowed values: available deleted

accessGuaranteedUntil

integer

deleteAfter

integer

deleteReason

string

Allowed values: manual automatic_cleanup

deletedAt

integer

nextCursor

string

Example

{
  "items": [
    {
      "job": {
        "status": "queued",
        "outputMode": "transient"
      },
      "output": {
        "state": "available",
        "deleteReason": "manual"
      }
    }
  ]
}

404

Requested resource was not found.

Media type application/json

object

error

required

string

message

required

string

Example ^generated

{
  "error": "example",
  "message": "example"
}