Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Pay Inputs

List pay inputs

Pay inputs are the individual compensation components (e.g. Base Salary, Sign-on Bonus, Equity) that make up a Greenhouse pay transparency rule. Site Admins configure them under Configure > Privacy & Compliance, and each pay input belongs to a pay transparency rule that gets attached to a job post; the dollar amounts themselves live on the sibling /v3/pay_input_ranges resource. Pay inputs may optionally sync from a currency-range custom job field via linked_custom_field_id — when present, the pay range is sourced from that field and is locked on the job post if locked is true.

get/v3/pay_inputs

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
linked_custom_field_idsinteger[]

Return only pay inputs whose source custom field id matches one of these values. A pay input's linked_custom_field is the custom field configured to feed this pay-input row (exposed as linked_custom_field_id on the response).

fieldsstring[]

Comma separated list of fields to return

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
titlestring

Label shown to candidates above this pay component on the job post (e.g. Base Salary, Sign-on Bonus, Equity). Configured by Site Admins under Configure > Privacy & Compliance and not editable from the job post.

blurbstring nullable

Optional descriptive copy shown alongside title on the job post — typically context or caveats about the component (e.g. Annual base salary, exclusive of variable compensation). May contain sanitized HTML. null when no description was supplied.

priorityinteger

Display order within the parent pay transparency rule. Lower values render first on the job post; pay inputs share this ordering with their associated pay_input_ranges.

linked_custom_field_idinteger nullable

Id of the currency-range custom job field this pay input syncs from, or null when the range is entered directly on each job post. When set, the pay range on the job post is sourced from the linked custom field rather than from manual entry.

lockedboolean

true when the linked custom field is the single source of truth and the pay range is not editable on the job post — set by the Site Admin via the Mark the value as not editable on the job post setting. Always false when linked_custom_field_id is null.