VeristageDevelopers
Jobs

List the linked user's recent jobs

GET/jobs

Returns jobs submitted by this api-key's linked service user, newest first. Only the caller's own jobs are visible. Requires the read scope.

Authorization

apiKey
X-Api-Key<token>

Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.

In: header

Query Parameters

limit?integer

Page size (clamped to 1–100).

Range1 <= value <= 100
Default20
offset?integer
Range0 <= value
Default0
type?string

Filter by job type.

Value in

  • "proofreading"
  • "translate"
  • "adapt"
  • "style-coding"
  • "corrections-check"
  • "accessibility-check"
  • "document-index"
  • "scan"
status?integer

Filter by numeric status (0 pending, 1 ready, 2 complete, 3 running, 5 failed).

Value in

  • 0
  • 1
  • 2
  • 3
  • 5

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/jobs"
{  "data": {    "jobs": [      {        "jobRef": 555,        "type": "proofreading",        "status": {          "code": 1,          "label": "ready"        },        "progress": 50,        "createdAt": "2026-07-15 09:00:00"      }    ],    "total": 12,    "limit": 20,    "offset": 0  }}
{  "success": false,  "status": "fail",  "message": "string",  "error": {    "message": "API key is required",    "code": "NO_API_KEY"  }}

{  "success": false,  "status": "fail",  "message": "API key is required",  "error": {    "code": "NO_API_KEY",    "message": "API key is required"  }}

{  "success": false,  "status": "fail",  "message": "This API key does not have the 'write' scope",  "error": {    "code": "INSUFFICIENT_SCOPE",    "message": "This API key does not have the 'write' scope"  }}

Poll one job GET

Returns the current state of a job the caller owns. A job belonging to another user (or that does not exist) returns `404 NOT_FOUND` — the two cases are deliberately indistinguishable. Requires the `read` scope.

Submit a job POST

Queue a long-running job scoped to the linked user + usergroup. The `type` must be one of the externally-submittable job types; `params` must carry the `resource` ref the job operates on plus any per-type options. All usergroup, feature-flag, file-type and permission checks are the same as the in-app path. Requires the `write` scope. Supports the `Idempotency-Key` header: a retry with the same key + body within 24h replays the original response (`Idempotent-Replayed: true`) instead of queuing a second job. Reusing a key with a different body returns `422 IDEMPOTENCY_KEY_CONFLICT`.