Skip to main content
GET
Jobs Search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0
q
string
default:""
order
string | null
dir
string
default:desc
status
string[] | null
role
string[] | null
recipe
string[] | null
framework
string[] | null
profile
string[] | null
username
string[] | null
tag
string[] | null
project_key
string
default:""
exp
string
default:""
since
string | null
until
string | null
active
boolean
default:false
include_chained
boolean
default:false
facets
boolean
default:true

Response

Successful Response

A page of the ledger, its total, and the counts behind each filter.

facets is keyed by field name (status / recipe / framework / profile / username). Each list is counted with every other active filter applied but not its own, so switching one value for another within a facet does not first empty the page.

jobs
JobRowOut · object[]
total
integer
default:0
facets
Facets · object