OpenPost Jobs API
The Jobs API from OpenPost — 2 operation(s) for jobs.
The Jobs API from OpenPost — 2 operation(s) for jobs.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/openpo-st:openpo-st-jobs-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: hello@openpo.st
name: OpenPost support
url: https://openpo.st/contact
description: OpenPost HTTP API for workspace-scoped social publishing. Use it to inspect accounts and provider readiness, manage media and publications, schedule work, and read publishing results. Every operation still follows token scopes, workspace roles, plan limits, provider capabilities, and destination validation.
license:
identifier: AGPL-3.0-only
name: AGPL-3.0-only
termsOfService: https://openpo.st/terms
title: OpenPost Jobs API
version: 1.0.0
servers:
- description: OpenPost Hosted service
url: https://app.openpo.st/api/v1
- description: The OpenPost instance serving this contract
url: /api/v1
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: Jobs
paths:
/jobs:
get:
operationId: list-jobs
parameters:
- description: Number of jobs to return (default 50, max 200)
explode: false
in: query
name: limit
schema:
description: Number of jobs to return (default 50, max 200)
format: int64
type: integer
- description: Offset for pagination
explode: false
in: query
name: offset
schema:
description: Offset for pagination
format: int64
type: integer
- description: Opaque cursor for stable newest-first pagination
explode: false
in: query
name: cursor
schema:
description: Opaque cursor for stable newest-first pagination
type: string
- description: Filter by status (pending, processing, completed, failed)
explode: false
in: query
name: status
schema:
description: Filter by status (pending, processing, completed, failed)
type: string
- description: Filter by workspace ID
explode: false
in: query
name: workspace_id
schema:
description: Filter by workspace ID
type: string
- description: Include jobs scheduled at or after this RFC3339 timestamp
explode: false
in: query
name: run_from
schema:
description: Include jobs scheduled at or after this RFC3339 timestamp
type: string
- description: Include jobs scheduled before this RFC3339 timestamp
explode: false
in: query
name: run_before
schema:
description: Include jobs scheduled before this RFC3339 timestamp
type: string
- description: Restrict to one kind of work; publishing lists only post delivery jobs
explode: false
in: query
name: category
schema:
description: Restrict to one kind of work; publishing lists only post delivery jobs
enum:
- publishing
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/JobResponse'
type:
- array
- 'null'
description: OK
headers:
X-Has-More:
schema:
description: Whether another page is available
type: boolean
X-Limit:
schema:
description: Applied page limit
format: int64
type: integer
X-Next-Cursor:
schema:
description: Opaque cursor for the next page
type: string
X-Next-Offset:
schema:
description: Offset for the next page
format: int64
type: integer
X-Offset:
schema:
description: Applied page offset
format: int64
type: integer
X-Total-Count:
schema:
description: Total number of matching jobs
format: int64
type: integer
default:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Error
summary: List recent background jobs
tags:
- Jobs
x-openpost-automation:
access: read
effect: query
exposure: alpha
idempotency: none
retry: transient
selectors:
- label_path: name
operation_id: list-workspaces
parameter: workspace_id
value_path: id
/jobs/{id}:
get:
operationId: get-job
parameters:
- description: Job ID
in: path
name: id
required: true
schema:
description: Job ID
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
description: OK
'403':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Forbidden
'404':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Not Found
'422':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Unprocessable Entity
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ErrorModel'
description: Internal Server Error
summary: Get a background job
tags:
- Jobs
x-openpost-automation:
access: read
effect: query
exposure: alpha
idempotency: none
result:
id_path: $.id
retry: transient
components:
schemas:
ErrorDetail:
additionalProperties: false
properties:
location:
description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
type: string
message:
description: Error message text
type: string
value:
description: The value at the given location
type: object
ErrorModel:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/ErrorModel.json
format: uri
readOnly: true
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
examples:
- Property foo is required but is missing.
type: string
errors:
description: Optional list of individual error details
items:
$ref: '#/components/schemas/ErrorDetail'
type:
- array
- 'null'
instance:
description: A URI reference that identifies the specific occurrence of the problem.
examples:
- https://example.com/error-log/abc123
format: uri
type: string
status:
description: HTTP status code
examples:
- 400
format: int64
type: integer
title:
description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
examples:
- Bad Request
type: string
type:
default: about:blank
description: A URI reference to human-readable documentation for the error.
examples:
- https://example.com/errors/example
format: uri
type: string
type: object
JobResponse:
additionalProperties: false
properties:
$schema:
description: A URL to the JSON Schema for this object.
examples:
- https://example.com/api/v1/schemas/JobResponse.json
format: uri
readOnly: true
type: string
attempts:
description: Number of attempts
format: int64
type: integer
created_at:
description: Creation time
type: string
id:
description: Job ID
type: string
last_error:
description: Last error message
type: string
locked_at:
description: When job was locked
type: string
max_attempts:
description: Maximum attempts
format: int64
type: integer
payload:
description: Job payload
type: string
publication_id:
description: Publication associated with this job, when available
type: string
run_at:
description: Scheduled run time
type: string
status:
description: Job status
type: string
type:
description: Job type
type: string
required:
- id
- type
- status
- run_at
- attempts
- max_attempts
- created_at
type: object
securitySchemes:
bearerAuth:
bearerFormat: OpenPost API token or session JWT
scheme: bearer
type: http
sessionCookie:
in: cookie
name: openpost_session
type: apiKey