Jobs

List recent background jobs

get/jobs

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/jobs
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Query parameters

limitinteger

Number of jobs to return (default 50, max 200)

offsetinteger

Offset for pagination

cursorstring

Opaque cursor for stable newest-first pagination

statusstring

Filter by status (pending, processing, completed, failed)

workspace_idstring

Filter by workspace ID

run_fromstring

Include jobs scheduled at or after this RFC3339 timestamp

run_beforestring

Include jobs scheduled before this RFC3339 timestamp

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

attemptsinteger required

Number of attempts

created_atstring required

Creation time

idstring required

Job ID

last_errorstring

Last error message

locked_atstring

When job was locked

max_attemptsinteger required

Maximum attempts

payloadstring

Job payload

publication_idstring

Publication associated with this job, when available

run_atstring required

Scheduled run time

statusstring required

Job status

typestring required

Job type

Example response

[
  {
    "$schema": "https://example.com/api/v1/schemas/JobResponse.json"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.