List jobs

GET 
/job

Retrieve jobs, optionally filtered by status.

Request

Query Parameters

status string

Filter jobs by status (e.g., unprocessed, processing, completed, failed).

Responses

200

A list of jobs.

application/json

Schema

Schema

total_items integer

Total number of jobs matching the filter.

items

object[]

Array [

id string

Unique identifier of the job.

status string

Current status of the job.

created string

Creation timestamp.

operation

object

The operation data.

property name* any

The operation data.

result

The result data if completed.

error string

Error message if failed.

hostname string

Worker hostname that processed the job.

updated_at string

Last update timestamp.

]

Example (from schema)

{
  "total_items": 42,
  "items": [
    {
      "id": "string",
      "status": "string",
      "created": "string",
      "operation": {},
      "error": "string",
      "hostname": "string",
      "updated_at": "string"
    }
  ]
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error listing jobs.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...