---
title: "List User Field Options"
method: GET
path: "/api/v2/user_fields/{user_field_id}/options"
tags: ["User Fields"]
---

# List User Field Options

`GET /api/v2/user_fields/{user_field_id}/options`

Returns a list of custom user field options for the given dropdown user field.

#### Pagination

* Cursor pagination (recommended)
* Offset pagination

See [Pagination](/api-reference/introduction/pagination/).

Returns a maximum of 100 records per page.

#### Allowed For

* Agents

## Query parameters

- `page[before]` string
- `page[after]` string
- `page[size]` integer

## Response `200`

Success response

- CustomFieldOptionsResponse
  - `count` integer — Total count of records retrieved
  - `custom_field_options` CustomFieldOptionObject[]
    - `id` integer — Automatically assigned upon creation
    - `name` string, required — Name of the dropdown option
    - `position` integer — Position of the dropdown option
    - `raw_name` string — Raw name of the dropdown option
    - `url` string — URL of the dropdown option
    - `value` string, required — Value of the dropdown option
  - `next_page` string, nullable — URL of the next page
  - `previous_page` string, nullable — URL of the previous page

## Changes

> 29 revisions in range; 1 not diffed.

- **2025-06-12** `edbf399da815` — 3 info
  - added the new optional `query` request parameter `page[after]`
  - added the new optional `query` request parameter `page[before]`
  - added the new optional `query` request parameter `page[size]`

[Change history](https://skmtc.dev/botbrains-io/apis/support-api/changes/api/v2/user_fields/:user_field_id/options/get.md)

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)