Skip to main content
GET
/
jobs
List Jobs
curl --request GET \
  --url https://v1.api.flux-os.com/jobs \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": [
    {
      "queue_name": "<string>",
      "queue_function": "<string>",
      "type": "T",
      "id": "<string>",
      "status": "QUEUED",
      "enqueued_at": "2023-11-07T05:31:56Z",
      "started_at": null,
      "finished_at": null
    }
  ],
  "meta": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "per_page": 123
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
type
enum<string>

Filter by job type

Available options:
TANK_TICKET,
METER_TICKET,
TRUCK_TICKET
status
enum<string>

Filter by job status

Available options:
QUEUED,
STARTED,
FINISHED,
FAILED,
SCHEDULED

Response

A paginated list of jobs.

data
object[]
meta
object