GRgreenhouse
Custom Field Offices

List custom field offices

A custom_field_office restricts a custom field's visibility to a single office, so the field only appears on jobs, openings, or offers whose office matches. A custom field with no rows in this list is visible to every office — the right default for remote-first or single-office orgs that don't scope fields by location. Filter by custom_field_ids to see which offices a given field is scoped to, or by office_ids to see which fields are scoped to a given office. Office scoping composes with /v3/custom_field_departments: a field carrying both kinds of rows is only visible where both an office and department match.

get/v3/custom_field_offices

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/custom_field_offices
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:custom_field_offices: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
custom_field_idsinteger[]

Comma separated list

office_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
custom_field_idinteger

Id of the custom field whose visibility is being scoped. References a /v3/custom_fields row.

office_idinteger

Id of the office the custom field is restricted to. References a /v3/offices row.

Changes

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