---
title: "Get custom field options"
method: GET
path: "/users/v1/custom-fields/{customFieldId}/options"
tags: ["Users:v1:Custom Fields:Custom Field options"]
---

# Get custom field options

`GET /users/v1/custom-fields/{customFieldId}/options`

Retrieve a list of all dropdown value options under a specified custom field

## Path parameters

- `customFieldId` integer, required — The unique identifier of the custom field

## Query parameters

- `limit` integer — The maximum number of results to display per page
- `offset` integer — The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
- `isDisabled` boolean — Parameter specifying the if to filter only for disabled options.
- `isDeleted` boolean — Parameter specifying the if to filter only for deleted options.

## Response `200`

Successful Response

- PaginatedBaseResponseCustomFieldOptionsResponse
  - `requestId` string
  - `data` CustomFieldOptionsResponse, required
    - `options` DropdownCustomFieldOptionResponse[], required — The custom field options
      - `id` integer, required — The id of this option
      - `value` string, required — The name of this option
      - `isDisabled` boolean — Indicates if this option is disabled
      - `isDeleted` boolean — Indicates if this option is deleted (this will still be returned in case someone already chose this option so you can see the value).
  - `paging` PagingResponseModel, required
    - `offset` integer, required — The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
    - `total` integer — Total number of resources matching the request, ignoring pagination. Use this to retrieve the full count without paginating through every page. Only populated by endpoints that compute it.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/connecteam/apis/connecteam-api-documentation.md) · [All operations](https://skmtc.net/connecteam/apis/connecteam-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/connecteam/connecteam-api-documentation/revisions/d8f7f302222e/schema)