---
title: "List custom fields"
method: GET
path: "/v0/custom_fields"
tags: ["Custom Fields"]
---

# List custom fields

`GET /v0/custom_fields`

## Request

- Base URL: `https://api.gem.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gem.com/v0/custom_fields`
- Auth: none declared

Returns a list of all custom fields. Supports pagination
and search parameters `created_after`, `created_before`.

## Query parameters

- `created_after` integer
- `created_before` integer
- `sort` 'asc' | 'desc'
- `project_id` string, ObjectID, nullable
- `scope` 'team' | 'project'
- `is_hidden` boolean
- `name` string
- `page` integer
- `page_size` integer

## Response `200`

OK

- CustomField[]
  - `id` string, ObjectID
  - `created_at` integer
  - `name` string
  - `value_type` 'date' | 'text' | 'single_select' | 'multi_select': When `value_type` is `text`, `value` is a string. When `value_type` is `date`, `value` is a string of format `yyyy-mm-dd`. When `value_type` is `single_select`, `value` is a string of an option value. When `value_type` is `multi_select`, `value` is an array of strings of option values.
  - `scope` 'team' | 'project': Custom fields under `team` scope apply to all candidates. Custom fields under `project` scope apply to candidates in a specific project.
  - `project_id` string, ObjectID: If the custom field has `project` scope, this is the project ID that its associated with.
  - `is_hidden` boolean: `hidden` custom fields in the candidate info are not displayed in the Gem product or not returned when making a query on the Candidates endpoint.
  - `options` CustomFieldOption[]: Applicable when `value_type` is one of (`single_select`, `multi_select`).
    - `id` string, ObjectID
    - `value` string
    - `is_hidden` boolean: `hidden` options are not selectable in the Gem product. Candidate custom field values with `hidden` options are not returned when making a query to the Candidates endpoint.

## Other responses

- `422`: Unprocessable Content
- `default`: Default error response

---

[API](https://skmtc.dev/gem/apis/gem-crm-api.md) - [All operations](https://skmtc.dev/gem/apis/gem-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gem/apis/gem-crm-api/revisions/50a984e3c2b5?raw)