View input schema
{
"type": "object",
"properties": {
"companySlug": {
"type": "string",
"description": "The company slug from search-companies. Send companyName instead only when search-companies has no match.",
"example": "google"
},
"companyName": {
"type": "string",
"description": "The company name, only for a company that search-companies cannot find.",
"example": "Acme Robotics"
},
"jobFamilySlug": {
"type": "string",
"description": "A Levels.fyi job family slug, e.g. \"software-engineer\", \"product-manager\", \"data-scientist\".",
"example": "software-engineer"
},
"title": {
"type": "string",
"description": "The job title as the user states it, e.g. \"Software Engineer\". In English.",
"example": "Software Engineer"
},
"level": {
"type": "string",
"description": "The company's own level name from get-company-levels, e.g. \"L5\". Required for companies with a level ladder; the error says so.",
"example": "L5"
},
"focusTagSlug": {
"type": "string",
"description": "A focus area slug from get-job-family for this job family, e.g. \"ml-ai\". Omit when the user did not name one.",
"example": "ml-ai"
},
"team": {
"type": "string",
"description": "The team or organization within the company, e.g. \"Google Cloud\". In English."
},
"locationSlug": {
"type": "string",
"description": "A CITY slug from search-locations with type \"city\". Not a metro, state or country.",
"example": "seattle-usa"
},
"compensationPerspective": {
"type": "string",
"enum": [
"offer",
"employee"
],
"description": "\"offer\" for a job offer the user received, \"employee\" for pay they earn now."
},
"sourceDate": {
"type": "string",
"description": "YYYY-MM-DD. For an offer, the offer date (required). For an employee, the date the pay was current; omit for today.",
"example": "2026-09-15"
},
"currency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"JPY",
"AUD",
"CAD",
"CHF",
"CNY",
"HKD",
"NZD",
"SEK",
"SGD",
"INR",
"RUB",
"AED",
"ILS",
"SAR",
"CZK",
"MXN",
"ZAR",
"THB",
"BRL",
"TWD",
"PKR",
"PLN",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BSD",
"BTC",
"BTN",
"BWP",
"BYN",
"BZD",
"CDF",
"CLF",
"CLP",
"CNH",
"COP",
"CRC",
"CUP",
"CVE",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"FJD",
"FKP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HNL",
"HTG",
"HUF",
"IDR",
"IMP",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"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",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PYG",
"QAR",
"RON",
"RSD",
"RWF",
"SBD",
"SCR",
"SDG",
"SHP",
"SLE",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TZS",
"UAH",
"UGX",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XDR",
"XOF",
"XPF",
"YER",
"ZMW",
"ZWL"
],
"description": "The currency of every amount in this submission, e.g. \"USD\", \"INR\", \"GBP\".",
"example": "USD"
},
"baseSalaryValue": {
"type": "number",
"description": "The base salary per baseSalaryTimeUnit.",
"example": 185000
},
"baseSalaryTimeUnit": {
"type": "string",
"enum": [
"hourly",
"monthly",
"yearly",
"one-time",
"quarterly",
"semi-monthly",
"bi-weekly",
"weekly",
"daily"
],
"description": "The period baseSalaryValue is paid per, usually \"yearly\".",
"example": "yearly"
},
"totalStockGrantValue": {
"type": "number",
"description": "Offers only: the total value of the stock (RSU) grant over the whole vesting period. Send vestingSchedule with it.",
"example": 400000
},
"vestingSchedule": {
"description": "Offers only; required with totalStockGrantValue. The vesting schedule, one entry per year: percent of the grant vesting that year and occurrences (vests that year, 4 = quarterly). 4 equal years vesting quarterly is four entries of {percent:25,occurrences:4}. Ask the user, or use get-vesting-schedules for the company standard; never assume one.",
"type": "array",
"items": {
"type": "object",
"properties": {
"percent": {
"type": "number"
},
"occurrences": {
"type": "number"
},
"monthlyVests": {
"description": "Monthly vests in a year",
"minItems": 12,
"maxItems": 12,
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"percent",
"occurrences"
]
}
},
"avgAnnualStockGrantValue": {
"type": "number",
"description": "Employees only: the stock (RSU) value they receive per year.",
"example": 100000
},
"stockType": {
"type": "string",
"enum": [
"stock",
"option"
],
"description": "\"stock\" for RSUs, \"option\" for stock options. Optional: it follows from the fields sent. One type per submission."
},
"totalOptionsGranted": {
"type": "number",
"description": "Offers only: the number of stock options in the whole grant. Send vestingSchedule with it.",
"example": 40000
},
"avgAnnualOptionsGranted": {
"type": "number",
"description": "Employees only: the number of stock options that vest per year.",
"example": 10000
},
"optionStrikePrice": {
"type": "number",
"description": "With options: the exercise (strike) price per option. Send with optionPreferredPrice; together they value the options.",
"example": 1.5
},
"optionPreferredPrice": {
"type": "number",
"description": "With options: the latest preferred share price, usually from the last funding round. Send with optionStrikePrice.",
"example": 6
},
"optionPriceCurrency": {
"type": "string",
"enum": [
"USD",
"EUR",
"GBP",
"JPY",
"AUD",
"CAD",
"CHF",
"CNY",
"HKD",
"NZD",
"SEK",
"SGD",
"INR",
"RUB",
"AED",
"ILS",
"SAR",
"CZK",
"MXN",
"ZAR",
"THB",
"BRL",
"TWD",
"PKR",
"PLN",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BSD",
"BTC",
"BTN",
"BWP",
"BYN",
"BZD",
"CDF",
"CLF",
"CLP",
"CNH",
"COP",
"CRC",
"CUP",
"CVE",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"FJD",
"FKP",
"GEL",
"GGP",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HNL",
"HTG",
"HUF",
"IDR",
"IMP",
"IQD",
"IRR",
"ISK",
"JEP",
"JMD",
"JOD",
"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",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PYG",
"QAR",
"RON",
"RSD",
"RWF",
"SBD",
"SCR",
"SDG",
"SHP",
"SLE",
"SOS",
"SRD",
"STD",
"SVC",
"SYP",
"SZL",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TZS",
"UAH",
"UGX",
"UYU",
"UZS",
"VEF",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XCD",
"XDR",
"XOF",
"XPF",
"YER",
"ZMW",
"ZWL"
],
"description": "The currency of optionStrikePrice and optionPreferredPrice, when it differs from currency (e.g. US-dollar option prices on a rupee salary)."
},
"annualBonusValue": {
"type": "number",
"description": "The yearly bonus: for an offer the target bonus amount, for an employee the bonus they actually receive per year.",
"example": 25000
},
"annualTargetBonusPercentage": {
"type": "number",
"description": "Offers only: the target bonus as a percent of base, when stated that way.",
"example": 15
},
"signOnBonusValues": {
"description": "Offers only: the sign-on bonus, one amount per year it is paid, e.g. [50000] or [30000, 20000].",
"type": "array",
"items": {
"type": "number"
}
},
"relocationBonusValue": {
"type": "number",
"description": "Offers only: the relocation bonus.",
"example": 10000
},
"yearsOfExperience": {
"type": "number",
"description": "Total years of professional experience, in whole years; a decimal is rounded.",
"example": 6
},
"yearsAtCompany": {
"type": "number",
"description": "Employees only (required): years at this company. Offers are always 0.",
"example": 2
},
"workArrangement": {
"type": "string",
"enum": [
"remote",
"office",
"hybrid"
],
"example": "hybrid"
},
"employmentType": {
"type": "string",
"enum": [
"full_time",
"part_time",
"contract",
"temporary",
"internship",
"volunteer",
"other"
],
"description": "Defaults to full_time."
},
"otherDetails": {
"type": "string",
"description": "Anything else the user wants recorded, e.g. a retention bonus, or RSUs when the submission already has options (or the reverse). In English, at most 500 characters."
},
"anonymise": {
"type": "boolean",
"description": "Enhanced anonymity, as on the website: true can hide details such as company, title, level and team on the public entry; the pay still counts in the data. Set it only when the user asks for it. Defaults to false.",
"default": false
},
"source": {
"type": "string",
"enum": [
"user_stated",
"user_document"
],
"description": "\"user_stated\" when the user typed the numbers, \"user_document\" when they come from an offer letter or pay stub the user shared."
},
"email": {
"type": "string",
"format": "email",
"description": "Required when the user isn't signed in. Used to verify the submission; never shown with it."
},
"confirm": {
"type": "boolean",
"description": "false (default) returns a preview and adds nothing to Levels.fyi. true adds the entry: only after the user said yes to the preview.",
"default": false
}
},
"required": [
"jobFamilySlug",
"title",
"locationSlug",
"compensationPerspective",
"currency",
"baseSalaryValue",
"baseSalaryTimeUnit",
"yearsOfExperience",
"workArrangement",
"source"
]
}