---
title: "Fetching a list of Custom Field Choices"
method: GET
path: "/custom_field_choices"
tags: ["Custom Field Choices"]
---

# Fetching a list of Custom Field Choices

`GET /custom_field_choices`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/custom_field_choices`
- Auth: none declared

Returns all possible choices for all `'single'` and `'multi'` type custom fields on the requester's account.

This endpoint returns structured Custom Field Choice objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `custom_field_choices` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `active` boolean
- `created_after` string, date-time
- `created_before` string, date-time
- `external_reference_external_message` string
- `external_reference_external_status` string
- `external_reference_service_model` string
- `external_reference_service_model_ref` integer
- `external_reference_service_model_refs` string
- `external_reference_service_name` string
- `external_reference_status` string
- `for_choice_ids` string
- `for_custom_fields` string
- `has_external_references` boolean
- `include` string
- `matching` string
- `only` string
- `order` string
- `page` integer
- `per_custom_field` integer
- `per_page` integer
- `updated_after` string, date-time
- `updated_before` string, date-time
- `without_external_reference_service_name` string

## Response `200`

A list of Custom Field Choices have been retrieved.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `custom_field_choices` object
  - `external_references` object
  - `custom_fields` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)