GRgreenhouse
Pay Input Ranges

List pay input ranges

Pay input ranges are the per-job-post minimum and maximum values for a pay component (e.g. base salary, bonus) referenced by a pay transparency rule. Each range belongs to one pay_input and one job_post; the same job can publish different ranges on different posts. Greenhouse renders these ranges on public job posts to satisfy pay transparency laws (e.g. NY, CA, CO). min_cents and max_cents are expressed in the smallest unit of currency_type and are 0 when the range has not yet been filled in on the job post.

get/v3/pay_input_ranges

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/pay_input_ranges
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:pay_input_ranges:list
    • or HTTP bearer

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
pay_input_idsinteger[]

Return only pay input ranges belonging to these pay input ids. Each pay input can have multiple ranges, one per location.

job_post_idsinteger[]

Return only pay input ranges whose pay input is attached to one of these job post ids. A job post can have multiple pay inputs, each with its own set of ranges.

fieldsstring[]

Comma separated list of fields to return

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
pay_input_idinteger

Id of the pay_input this range fills in (e.g. the Base Salary pay input on a pay transparency rule). Multiple ranges can share a pay_input when a job post has more than one component (e.g. base salary plus bonus).

currency_typestring

ISO 4217 currency code for min_cents and max_cents (e.g. USD, EUR, GBP). Defaults to USD.

min_centsinteger

Lower bound of the pay range, expressed in the smallest unit of currency_type (e.g. cents for USD). 0 when the range has not been filled in on the job post.

max_centsinteger

Upper bound of the pay range, expressed in the smallest unit of currency_type (e.g. cents for USD). 0 when the range has not been filled in on the job post.

job_post_idinteger

Id of the job_post this range is attached to. Pay transparency ranges are stored per job post so the same job can publish different ranges on different posts.

Changes

No recorded changes to this operation across all 1 revision of this API.