GRgreenhouse
Custom Field Offices

Create custom field office

Restrict a custom field's visibility to one additional office. Each call adds one (custom_field_id, office_id) pair; repeat the call for each office the field should appear under. Once any custom_field_office rows exist for a field, it stops being visible to offices outside the list — so partners running multi-office or multi-region rollouts must add every office that should retain access.

post/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:create
    • or HTTP bearer

Request body

custom_field_idinteger required

Id of the custom field to scope. The field becomes visible only on jobs, openings, or offers whose office matches one of the field's custom_field_offices rows. Combines with any custom_field_departments rows — both scopings can restrict the same field at once.

office_idinteger required

Id of the office to grant visibility to. Must belong to the same organization as the custom field.

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.