List jobs

Returns a keyset-paginated list of open, commercially cleared jobs matching the supplied filters. Filters combine with AND across dimensions and OR within each repeated dimension.

GET/v0/jobs

Authentication

bearerAuth · http bearer

Organisation API key supplied only through the Authorization header.

Required scopes: jobs:read.

Parameters

Name	Type	Description
`query`optional	stringquery	Full-text query matched against indexed job text and title similarity. Normalized to Unicode NFC with folded whitespace; 1–200 characters. Schema and examples `string` Full-text query matched against indexed job text and title similarity. Normalized to Unicode NFC with folded whitespace; 1–200 characters. Examples `["software engineer"]` Maximum length `200` Minimum length `1` example-1: `software engineer`
`roles`optional	string[]query	Stable role family or specialism codes from the versioned Luranta role taxonomy. Repeat the parameter to match any supplied code; maximum 50. Discover values with GET /v0/taxonomies/roles. Browse available values Serialization: form; explode true Schema and examples `string[]` Stable role family or specialism codes from the versioned Luranta role taxonomy. Repeat the parameter to match any supplied code; maximum 50. Discover values with GET /v0/taxonomies/roles. Default `[]` Examples `[["software-engineering"]]` Maximum items `50` Items `string` Maximum length `160` Minimum length `1` Pattern `^[a-z0-9]+(?:[-_.][a-z0-9]+)*$` example-1: `["software-engineering"]`
`locations`optional	string[]query	Canonical location IDs: region:EMEA, region:APAC, region:AMERICAS, country:<ISO 3166-1 alpha-2>, admin:<code>, or city:geonames:<ID>. Metro IDs are accepted when present in the location catalogue. Repeat to match any selector; maximum 300. Browse available values Serialization: form; explode true Schema and examples `string[]` Canonical location IDs: region:EMEA, region:APAC, region:AMERICAS, country:<ISO 3166-1 alpha-2>, admin:<code>, or city:geonames:<ID>. Metro IDs are accepted when present in the location catalogue. Repeat to match any selector; maximum 300. Default `[]` Examples `[["country:GB"]]` Maximum items `300` Items `string` Maximum length `240` Minimum length `1` example-1: `["country:GB"]`
`companies`optional	string<uuid>[]query	Company UUIDv7 identifiers. Repeat the parameter to match any supplied company; maximum 20. Serialization: form; explode true Schema and examples `string<uuid>[]` Company UUIDv7 identifiers. Repeat the parameter to match any supplied company; maximum 20. Default `[]` Examples `[["019bf6e2-a668-7a1b-811d-c5845c739754"]]` Maximum items `20` Items `string<uuid>` Format `uuid` Pattern `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$` example-1: `["019bf6e2-a668-7a1b-811d-c5845c739754"]`
`industries`optional	string[]query	Stable industry codes assigned to the hiring company from the versioned Luranta industry taxonomy. Repeat the parameter to match any supplied code; maximum 50. Discover values with GET /v0/taxonomies/industries. Browse available values Serialization: form; explode true Schema and examples `string[]` Stable industry codes assigned to the hiring company from the versioned Luranta industry taxonomy. Repeat the parameter to match any supplied code; maximum 50. Discover values with GET /v0/taxonomies/industries. Default `[]` Examples `[["technology"]]` Maximum items `50` Items `string` Maximum length `160` Minimum length `1` Pattern `^[a-z0-9]+(?:[-_.][a-z0-9]+)*$` example-1: `["technology"]`
`tools`optional	string[]query	Stable tool or technology codes identified for the job. Repeat the parameter to match any supplied code; discover evolving values with GET /v0/tools?query=...; maximum 50. Browse available values Serialization: form; explode true Schema and examples `string[]` Stable tool or technology codes identified for the job. Repeat the parameter to match any supplied code; discover evolving values with GET /v0/tools?query=...; maximum 50. Default `[]` Examples `[["typescript"]]` Maximum items `50` Items `string` Maximum length `160` Minimum length `1` Pattern `^[a-z0-9]+(?:[-_.][a-z0-9]+)*$` example-1: `["typescript"]`
`work_arrangements`optional	string[]query	Work arrangements: on_site, hybrid, or remote. Repeat the parameter to match any supplied value; maximum 50. Available options `on_sitehybridremote` Serialization: form; explode true Schema and examples `string[]` Work arrangements: on_site, hybrid, or remote. Repeat the parameter to match any supplied value; maximum 50. Default `[]` Examples `[["remote"]]` Maximum items `50` Items `string` Allowed values `["on_site","hybrid","remote"]` example-1: `["remote"]`
`schedules`optional	string[]query	Employment schedules: full-time or part-time. Repeat the parameter to match any supplied value; maximum 50. Available options `full-timepart-time` Serialization: form; explode true Schema and examples `string[]` Employment schedules: full-time or part-time. Repeat the parameter to match any supplied value; maximum 50. Default `[]` Examples `[["full-time"]]` Maximum items `50` Items `string` Allowed values `["full-time","part-time"]` example-1: `["full-time"]`
`engagements`optional	string[]query	Engagement types: permanent, fixed-term, contract-freelance, temporary-seasonal-casual, internship, apprenticeship, or volunteer. Repeat to match any supplied value; maximum 50. Available options `permanentfixed-termcontract-freelancetemporary-seasonal-casualinternshipapprenticeshipvolunteer` Serialization: form; explode true Schema and examples `string[]` Engagement types: permanent, fixed-term, contract-freelance, temporary-seasonal-casual, internship, apprenticeship, or volunteer. Repeat to match any supplied value; maximum 50. Default `[]` Examples `[["permanent"]]` Maximum items `50` Items `string` Allowed values `["permanent","fixed-term","contract-freelance","temporary-seasonal-casual","internship","apprenticeship","volunteer"]` example-1: `["permanent"]`
`experience_min`optional	integerquery	Lower bound of the acceptable experience range in whole years, from 0 to 20. Matches a stated job range that overlaps this bound. Schema and examples `integer` Lower bound of the acceptable experience range in whole years, from 0 to 20. Matches a stated job range that overlaps this bound. Examples `[2]` Maximum `20` Minimum `0` example-1: `2`
`experience_max`optional	integerquery	Upper bound of the acceptable experience range in whole years, from 0 to 20; 20 includes jobs requiring 20 years or more. Matches a stated job range that overlaps this bound. Schema and examples `integer` Upper bound of the acceptable experience range in whole years, from 0 to 20; 20 includes jobs requiring 20 years or more. Matches a stated job range that overlaps this bound. Examples `[5]` Maximum `20` Minimum `0` example-1: `5`
`include_unstated_experience`optional	booleanquery	When an experience bound is present, include jobs without a numeric experience requirement. Defaults to true and has no effect without an experience bound. Schema and examples `boolean` When an experience bound is present, include jobs without a numeric experience requirement. Defaults to true and has no effect without an experience bound. Default `true` Examples `[true]` example-1: `true`
`visa_sponsorship`optional	string[]query	Set to available to return only jobs explicitly marked as offering visa sponsorship. Available options `available` Serialization: form; explode true Schema and examples `string[]` Set to available to return only jobs explicitly marked as offering visa sponsorship. Default `[]` Examples `[["available"]]` Maximum items `50` Items `string` Constant `available` example-1: `["available"]`
`languages`optional	string[]query	Canonical BCP 47 language tags. A job must use a supplied listing language and satisfy each resolved language-requirement group with a supplied language. Repeat for alternatives; maximum 50. Serialization: form; explode true Schema and examples `string[]` Canonical BCP 47 language tags. A job must use a supplied listing language and satisfy each resolved language-requirement group with a supplied language. Repeat for alternatives; maximum 50. Default `[]` Examples `[["en-GB"]]` Maximum items `50` Items `string` Maximum length `35` Minimum length `2` example-1: `["en-GB"]`
`compensation_metric`optional	stringquery	Annual USD metric used by compensation bounds and sorting: base salary or target-cash. Defaults to base. Available options `basetarget-cash` Schema and examples `string` Annual USD metric used by compensation bounds and sorting: base salary or target-cash. Defaults to base. Allowed values `["base","target-cash"]` Default `base` Examples `["base"]` example-1: `base`
`compensation_min`optional	numberquery	Minimum annual USD threshold for the selected compensation metric. Matches a package whose upper bound, or lower bound when no upper bound exists, meets the threshold. Schema and examples `number` Minimum annual USD threshold for the selected compensation metric. Matches a package whose upper bound, or lower bound when no upper bound exists, meets the threshold. Examples `[60000]` Minimum `0` example-1: `60000`
`compensation_max`optional	numberquery	Maximum annual USD threshold for the selected compensation metric. Matches a package whose lower bound, or upper bound when no lower bound exists, does not exceed the threshold. Schema and examples `number` Maximum annual USD threshold for the selected compensation metric. Matches a package whose lower bound, or upper bound when no lower bound exists, does not exceed the threshold. Examples `[90000]` Minimum `0` example-1: `90000`
`bonus`optional	booleanquery	When true, require a matching compensation package that discloses a bonus. Defaults to false, which does not filter on bonuses. Schema and examples `boolean` When true, require a matching compensation package that discloses a bonus. Defaults to false, which does not filter on bonuses. Default `false` Examples `[true]` example-1: `true`
`commission`optional	booleanquery	When true, require a matching compensation package that discloses commission. Defaults to false, which does not filter on commission. Schema and examples `boolean` When true, require a matching compensation package that discloses commission. Defaults to false, which does not filter on commission. Default `false` Examples `[true]` example-1: `true`
`equity`optional	booleanquery	When true, require a matching compensation package that offers equity. Defaults to false, which does not filter on equity. Schema and examples `boolean` When true, require a matching compensation package that offers equity. Defaults to false, which does not filter on equity. Default `false` Examples `[true]` example-1: `true`
`freshness`optional	stringquery	Limits jobs by published_at, falling back to first_seen_at: any, 7-days, 30-days, 90-days, or 365-days. Defaults to any. Available options `any7-days30-days90-days365-days` Schema and examples `string` Limits jobs by published_at, falling back to first_seen_at: any, 7-days, 30-days, 90-days, or 365-days. Defaults to any. Allowed values `["any","7-days","30-days","90-days","365-days"]` Default `any` Examples `["30-days"]` example-1: `30-days`
`sort`optional	stringquery	Ordering field: updated and recommended use non-personalized publication or first-seen time; compensation uses the selected metric midpoint. Defaults to updated. Available options `recommendedcompensationupdated` Schema and examples `string` Ordering field: updated and recommended use non-personalized publication or first-seen time; compensation uses the selected metric midpoint. Defaults to updated. Allowed values `["recommended","compensation","updated"]` Default `updated` Examples `["updated"]` example-1: `updated`
`direction`optional	stringquery	Sort direction for the selected ordering field. UUIDv7 ID breaks ties. Defaults to desc. Available options `ascdesc` Schema and examples `string` Sort direction for the selected ordering field. UUIDv7 ID breaks ties. Defaults to desc. Allowed values `["asc","desc"]` Default `desc` Examples `["desc"]` example-1: `desc`
`cursor`optional	stringquery	Opaque keyset cursor from next_cursor. Reuse it with unchanged filters, sort, and direction; limit may change. Expires after 24 hours. Schema and examples `string` Opaque keyset cursor from next_cursor. Reuse it with unchanged filters, sort, and direction; limit may change. Expires after 24 hours. Maximum length `1000` Minimum length `1`
`limit`optional	integerquery	Maximum resources to return, from 1 to 100. Defaults to 20. Schema and examples `integer` Maximum resources to return, from 1 to 100. Defaults to 20. Default `20` Examples `[20]` Maximum `100` Minimum `1` example-1: `20`

Responses

A page of matching open jobs. The list may be empty.

application/json

Luranta-Cost-USDoptional

Credit consumed as a USD decimal string. Present only on successful billable responses.

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

Luranta-Credit-Balance-USDoptional

Organisation credit remaining after settlement. Present only on successful billable responses.

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

Luranta-Resources-Returnedoptional

Number of resources returned and charged. Present only on successful billable responses.

integer

Minimum: 0

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

JobListJobList

Additional properties: forbidden

Properties

datarequired

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

apply_urlrequired

string<uri> | null

anyOf

Option 1

string<uri>

Format: uri
Maximum length: 2048

Option 2

null

closed_atrequired

string<date-time> | null

anyOf

Option 1

string<date-time>

Format: date-time
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Option 2

null

companyrequired

object

Additional properties: forbidden

Properties

idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

namerequired

string

Maximum length: 240
Minimum length: 1

compensationrequired

object | null

anyOf

Option 1

object

Additional properties: forbidden

Properties

base_annual_maximumrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

base_annual_minimumrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

currencyrequired

string | null

anyOf

Option 1

string

Pattern: ^[A-Z]{3}$

Option 2

null

has_bonusrequired

boolean

has_commissionrequired

boolean

has_equityrequired

boolean

target_cash_annual_maximumrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

target_cash_annual_minimumrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

Option 2

null

compensationPackagesrequired

object[]

Default: []
Maximum items: 20

Items

object

Additional properties: forbidden

Properties

baseAnnualCurrencyrequired

string | null

anyOf

Option 1

string

Allowed values: ["AED","AFN","ALL","AMD","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SOS","SRD","SSP","STN","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWG","BGN"]

Option 2

null

baseAnnualMaxrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

baseAnnualMinrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

baseAnnualUsdMaxrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

baseAnnualUsdMinrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

componentsrequired

object[]

Maximum items: 20
Minimum items: 1

Items

object

oneOf

Option 1

object

Additional properties: forbidden

Properties

cadencerequired

string

Allowed values: ["recurring","one_time","unknown"]

conditionrequired

string

Allowed values: ["target","guaranteed","discretionary","maximum_only","unspecified"]

currencyrequired

string

Allowed values: ["AED","AFN","ALL","AMD","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SOS","SRD","SSP","STN","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWG","BGN"]

evidencerequired

string

Maximum length: 240
Minimum length: 1

intervalrequired

string

Allowed values: ["year","month","week","day","hour","none","unknown"]

kindrequired

string

Allowed values: ["base_pay","ote","commission","cash_bonus","equity","employer_total"]

maxoptional

number

Minimum: 0

minoptional

number

Minimum: 0

valueTyperequired

string

Constant: money

Option 2

object

Additional properties: forbidden

Properties

cadencerequired

string

Allowed values: ["recurring","one_time","unknown"]

conditionrequired

string

Allowed values: ["target","guaranteed","discretionary","maximum_only","unspecified"]

evidencerequired

string

Maximum length: 240
Minimum length: 1

intervalrequired

string

Allowed values: ["year","month","week","day","hour","none","unknown"]

kindrequired

string

Allowed values: ["base_pay","ote","commission","cash_bonus","equity","employer_total"]

maxoptional

number

Maximum: 1000
Minimum: 0

minoptional

number

Maximum: 1000
Minimum: 0

valueTyperequired

string

Constant: percentage

Option 3

object

Additional properties: forbidden

Properties

cadencerequired

string

Allowed values: ["recurring","one_time","unknown"]

conditionrequired

string

Allowed values: ["target","guaranteed","discretionary","maximum_only","unspecified"]

evidencerequired

string

Maximum length: 240
Minimum length: 1

intervalrequired

string

Allowed values: ["year","month","week","day","hour","none","unknown"]

kindrequired

string

Allowed values: ["base_pay","ote","commission","cash_bonus","equity","employer_total"]

maxoptional

number

Minimum: 0

minoptional

number

Minimum: 0

unitrequired

string

Maximum length: 40
Minimum length: 1

valueTyperequired

string

Constant: units

Option 4

object

Additional properties: forbidden

Properties

cadencerequired

string

Allowed values: ["recurring","one_time","unknown"]

conditionrequired

string

Allowed values: ["target","guaranteed","discretionary","maximum_only","unspecified"]

evidencerequired

string

Maximum length: 240
Minimum length: 1

intervalrequired

string

Allowed values: ["year","month","week","day","hour","none","unknown"]

kindrequired

string

Allowed values: ["base_pay","ote","commission","cash_bonus","equity","employer_total"]

valueTyperequired

string

Constant: disclosure

evidencerequired

string

Maximum length: 240
Minimum length: 1

fxObservedAtrequired

string<date-time> | null

anyOf

Option 1

string<date-time>

Format: date-time
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Option 2

null

hasBonusrequired

boolean

hasCommissionrequired

boolean

hasEquityrequired

boolean

scoperequired

object

Default: {"kind":"unspecified"}

oneOf

Option 1

object

Additional properties: forbidden

Properties

kindrequired

string

Constant: global

Option 2

object

Additional properties: forbidden

Properties

countryCoderequired

string

Allowed values: ["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]

kindrequired

string

Constant: country

Option 3

object

Additional properties: forbidden

Properties

adminAreaCoderequired

string

Pattern: ^[A-Z]{2}\.[A-Z0-9-]{1,12}$

kindrequired

string

Constant: admin

Option 4

object

Additional properties: forbidden

Properties

kindrequired

string

Constant: metro

metroIdrequired

string

Pattern: ^metro:[A-Za-z0-9][A-Za-z0-9._:-]{0,239}$

Option 5

object

Additional properties: forbidden

Properties

kindrequired

string

Constant: place

placeIdrequired

integer

Exclusive minimum: 0
Maximum: 9007199254740991

Option 6

object

Additional properties: forbidden

Properties

kindrequired

string

Constant: unspecified

sourcerequired

string

Allowed values: ["employer_feed","greenhouse_pay_transparency","structured_data","description"]

targetCashAnnualCurrencyrequired

string | null

anyOf

Option 1

string

Allowed values: ["AED","AFN","ALL","AMD","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SOS","SRD","SSP","STN","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWG","BGN"]

Option 2

null

targetCashAnnualMaxrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

targetCashAnnualMinrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

targetCashAnnualUsdMaxrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

targetCashAnnualUsdMinrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

compensationSelectionReasonrequired

string

Allowed values: ["unique","global","location_match","location_dependent","none"]
Default: none

engagementsrequired

string[]

Maximum items: 7

Items

string

Allowed values: ["permanent","fixed-term","contract-freelance","temporary-seasonal-casual","internship","apprenticeship","volunteer"]

experiencerequired

object

Additional properties: forbidden

Properties

maximum_yearsrequired

integer | null

anyOf

Option 1

integer

Maximum: 80
Minimum: 0

Option 2

null

minimum_yearsrequired

integer | null

anyOf

Option 1

integer

Maximum: 80
Minimum: 0

Option 2

null

unstatedrequired

boolean

first_seen_atrequired

string<date-time>

Format: date-time
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

languagesrequired

string[]

Maximum items: 50

Items

string

Maximum length: 35
Minimum length: 2

last_seen_atrequired

string<date-time>

Format: date-time
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

locationDisclosuresrequired

object[]

Default: []
Maximum items: 50

Items

object

Additional properties: forbidden

Properties

labelrequired

string

Maximum length: 240
Minimum length: 1

purposerequired

string

Allowed values: ["workplace","applicant_eligibility","unspecified"]

reasonrequired

string | null

anyOf

Option 1

string

Maximum length: 80
Minimum length: 1

Option 2

null

statusrequired

string

Allowed values: ["resolved","stated_unresolved","conflict"]

locationsrequired

object[]

Maximum items: 50

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 180
Minimum length: 1

countryrequired

string | null

anyOf

Option 1

string

Pattern: ^[A-Z]{2}$

Option 2

null

labelrequired

string

Maximum length: 240
Minimum length: 1

locationStaterequired

string

Allowed values: ["resolved","stated_unresolved","unstated","conflict"]
Default: unstated

objectrequired

string

Constant: job

primaryCompensationPackagerequired

object | null

Default: null

anyOf

Option 1

object

Additional properties: forbidden

Properties

baseAnnualCurrencyrequired

string | null

anyOf

Option 1

string

Allowed values: ["AED","AFN","ALL","AMD","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SOS","SRD","SSP","STN","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWG","BGN"]

Option 2

null

baseAnnualMaxrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

baseAnnualMinrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

baseAnnualUsdMaxrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

baseAnnualUsdMinrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

componentsrequired

object[]

Maximum items: 20
Minimum items: 1

Items

object

oneOf

Option 1

object

Additional properties: forbidden

Properties

cadencerequired

string

Allowed values: ["recurring","one_time","unknown"]

conditionrequired

string

Allowed values: ["target","guaranteed","discretionary","maximum_only","unspecified"]

currencyrequired

string

Allowed values: ["AED","AFN","ALL","AMD","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SOS","SRD","SSP","STN","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWG","BGN"]

evidencerequired

string

Maximum length: 240
Minimum length: 1

intervalrequired

string

Allowed values: ["year","month","week","day","hour","none","unknown"]

kindrequired

string

Allowed values: ["base_pay","ote","commission","cash_bonus","equity","employer_total"]

maxoptional

number

Minimum: 0

minoptional

number

Minimum: 0

valueTyperequired

string

Constant: money

Option 2

object

Additional properties: forbidden

Properties

cadencerequired

string

Allowed values: ["recurring","one_time","unknown"]

conditionrequired

string

Allowed values: ["target","guaranteed","discretionary","maximum_only","unspecified"]

evidencerequired

string

Maximum length: 240
Minimum length: 1

intervalrequired

string

Allowed values: ["year","month","week","day","hour","none","unknown"]

kindrequired

string

Allowed values: ["base_pay","ote","commission","cash_bonus","equity","employer_total"]

maxoptional

number

Maximum: 1000
Minimum: 0

minoptional

number

Maximum: 1000
Minimum: 0

valueTyperequired

string

Constant: percentage

Option 3

object

Additional properties: forbidden

Properties

cadencerequired

string

Allowed values: ["recurring","one_time","unknown"]

conditionrequired

string

Allowed values: ["target","guaranteed","discretionary","maximum_only","unspecified"]

evidencerequired

string

Maximum length: 240
Minimum length: 1

intervalrequired

string

Allowed values: ["year","month","week","day","hour","none","unknown"]

kindrequired

string

Allowed values: ["base_pay","ote","commission","cash_bonus","equity","employer_total"]

maxoptional

number

Minimum: 0

minoptional

number

Minimum: 0

unitrequired

string

Maximum length: 40
Minimum length: 1

valueTyperequired

string

Constant: units

Option 4

object

Additional properties: forbidden

Properties

cadencerequired

string

Allowed values: ["recurring","one_time","unknown"]

conditionrequired

string

Allowed values: ["target","guaranteed","discretionary","maximum_only","unspecified"]

evidencerequired

string

Maximum length: 240
Minimum length: 1

intervalrequired

string

Allowed values: ["year","month","week","day","hour","none","unknown"]

kindrequired

string

Allowed values: ["base_pay","ote","commission","cash_bonus","equity","employer_total"]

valueTyperequired

string

Constant: disclosure

evidencerequired

string

Maximum length: 240
Minimum length: 1

fxObservedAtrequired

string<date-time> | null

anyOf

Option 1

string<date-time>

Format: date-time
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Option 2

null

hasBonusrequired

boolean

hasCommissionrequired

boolean

hasEquityrequired

boolean

scoperequired

object

Default: {"kind":"unspecified"}

oneOf

Option 1

object

Additional properties: forbidden

Properties

kindrequired

string

Constant: global

Option 2

object

Additional properties: forbidden

Properties

countryCoderequired

string

Allowed values: ["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]

kindrequired

string

Constant: country

Option 3

object

Additional properties: forbidden

Properties

adminAreaCoderequired

string

Pattern: ^[A-Z]{2}\.[A-Z0-9-]{1,12}$

kindrequired

string

Constant: admin

Option 4

object

Additional properties: forbidden

Properties

kindrequired

string

Constant: metro

metroIdrequired

string

Pattern: ^metro:[A-Za-z0-9][A-Za-z0-9._:-]{0,239}$

Option 5

object

Additional properties: forbidden

Properties

kindrequired

string

Constant: place

placeIdrequired

integer

Exclusive minimum: 0
Maximum: 9007199254740991

Option 6

object

Additional properties: forbidden

Properties

kindrequired

string

Constant: unspecified

sourcerequired

string

Allowed values: ["employer_feed","greenhouse_pay_transparency","structured_data","description"]

targetCashAnnualCurrencyrequired

string | null

anyOf

Option 1

string

Allowed values: ["AED","AFN","ALL","AMD","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SOS","SRD","SSP","STN","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWG","BGN"]

Option 2

null

targetCashAnnualMaxrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

targetCashAnnualMinrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

targetCashAnnualUsdMaxrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

targetCashAnnualUsdMinrequired

number | null

anyOf

Option 1

number

Minimum: 0

Option 2

null

Option 2

null

published_atrequired

string<date-time> | null

anyOf

Option 1

string<date-time>

Format: date-time
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Option 2

null

rolesrequired

string[]

Maximum items: 20

Items

string

Maximum length: 160
Minimum length: 1
Pattern: ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$

schedulesrequired

string[]

Maximum items: 2

Items

string

Allowed values: ["full-time","part-time"]

source_updated_atrequired

string<date-time> | null

anyOf

Option 1

string<date-time>

Format: date-time
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Option 2

null

source_urlrequired

string<uri> | null

anyOf

Option 1

string<uri>

Format: uri
Maximum length: 2048

Option 2

null

statusrequired

string

Allowed values: ["open","closed"]

titlerequired

string

Maximum length: 300
Minimum length: 1

toolsrequired

string[]

Maximum items: 100

Items

string

Maximum length: 160
Minimum length: 1
Pattern: ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$

visa_sponsorshiprequired

string | null

anyOf

Option 1

string

Allowed values: ["available","unavailable"]

Option 2

null

work_arrangementsrequired

string[]

Maximum items: 3

Items

string

Allowed values: ["on_site","hybrid","remote"]

has_morerequired

boolean

next_cursorrequired

string | null

anyOf

Option 1

string

Maximum length: 1000

Option 2

null

objectrequired

string

Constant: list

The request contains an invalid parameter, parameter combination, or cursor.

This response uses Problem Details.

application/problem+json

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The organisation API key is missing, invalid, expired, or revoked.

This response uses Problem Details.

application/problem+json

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The organisation does not have enough credit to reserve this operation.

This response uses Problem Details.

application/problem+json

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The authenticated organisation lacks the required scope, or the browser origin is not allowed.

This response uses Problem Details.

application/problem+json

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The requested resource does not exist or is not available to this organisation.

This response uses Problem Details.

application/problem+json

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The server did not complete the request in time. This failure is non-billable and may be retried.

This response uses Problem Details.

application/problem+json

Retry-Afteroptional

Minimum number of seconds before retrying when supplied.

integer

Minimum: 0

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The organisation request rate was exceeded. Retry after the indicated delay.

This response uses Problem Details.

application/problem+json

Retry-Afteroptional

Minimum number of seconds before retrying when supplied.

integer

Minimum: 0

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

The service or durable usage settlement is temporarily unavailable. This failure is non-billable.

This response uses Problem Details.

application/problem+json

Retry-Afteroptional

Minimum number of seconds before retrying when supplied.

integer

Minimum: 0

traceparentrequired

W3C trace context generated for this request attempt.

string

Pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$

X-Request-Idrequired

Unique UUIDv7 identifier for this request attempt.

string<uuid>

Format: uuid

ProblemDetailsProblemDetails

Additional properties: forbidden

Properties

available_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

coderequired

string

Maximum length: 80
Minimum length: 1

detailrequired

string

Maximum length: 1000
Minimum length: 1

errorsoptional

object[]

Maximum items: 100

Items

object

Additional properties: forbidden

Properties

coderequired

string

Maximum length: 80
Minimum length: 1

messagerequired

string

Maximum length: 500
Minimum length: 1

pointerrequired

string

Pattern: ^\/.*

instancerequired

string

Pattern: ^\/.*

paramoptional

string

Maximum length: 160
Minimum length: 1

request_idrequired

string<uuid>

Format: uuid
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

required_credit_usdoptional

string

Pattern: ^(?:0|[1-9]\d*)\.\d{2,6}$

retryablerequired

boolean

statusrequired

integer

Maximum: 599
Minimum: 400

titlerequired

string

Maximum length: 120
Minimum length: 1

top_up_urloptional

string<uri>

Format: uri
Maximum length: 2048

typerequired

string<uri>

Format: uri
Maximum length: 2048

Pagination

Property	Value
Allows page size change	`true`
Cursor ttl seconds	`86400`
Has more path	`has_more`
Items path	`data`
Next cursor path	`next_cursor`
Style	`keyset`

Pricing

Property	Value
Count path	`data`
Meter	`job_resource`
Model	`returned_resource`
Resource	`job`