---
title: "List custom field departments"
method: GET
path: "/v3/custom_field_departments"
tags: ["Custom Field Departments"]
---

# List custom field departments

`GET /v3/custom_field_departments`

## Request

- Base URL: `https://harvest.greenhouse.io`
- URL: `https://harvest.greenhouse.io/v3/custom_field_departments`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://auth.greenhouse.io/authorize`
    - Client credentials
    - Token URL: `https://auth.greenhouse.io/token` scopes: `harvest:custom_field_departments:list`
  - HTTP bearer

A custom_field_department restricts a custom field's visibility to a single department, so the field only appears on jobs, offers, or candidates whose department matches. A custom field with no rows in this list is visible to every department. Filter by `custom_field_ids` to see which departments a given field is scoped to, or by `department_ids` to see which fields are scoped to a given department.

## Query parameters

- `cursor` string
- `per_page` integer
- `ids` integer[]
- `created_at` object
  - `gte` string, date-time
  - `lte` string, date-time
  - `gt` string, date-time
  - `lt` string, date-time
- `updated_at` object
  - `gte` string, date-time
  - `lte` string, date-time
  - `gt` string, date-time
  - `lt` string, date-time
- `custom_field_ids` integer[]
- `department_ids` integer[]
- `fields` string[]

## Response `200`

Successful

- object[]
  - `id` integer
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `custom_field_id` integer: Id of the custom field whose visibility is being scoped. References a `/v3/custom_fields` row.
  - `department_id` integer: Id of the department the custom field is restricted to. References a `/v3/departments` row.

---

[API](https://skmtc.dev/greenhouse/apis/harvest-api.md) - [All operations](https://skmtc.dev/greenhouse/apis/harvest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/greenhouse/apis/harvest-api/revisions/822822e3f771?raw)