---
title: "List all select options"
method: GET
path: "/custom-fields/{custom_field_id}/select-options"
tags: ["Custom fields"]
---

# List all select options

`GET /custom-fields/{custom_field_id}/select-options`

## Request

- Base URL: `https://api.perk.com`
- URL: `https://api.perk.com/custom-fields/{custom_field_id}/select-options`
- Auth: none declared. Required headers: `Authorization`, `Api-Version`

## Path parameters

- `custom_field_id` string, required

## Query parameters

- `limit` integer
- `offset` integer
- `query` string
- `status` string

## Headers

- `Authorization` string, required
- `Api-Version` string, required

## Response `200`

Returns 200 OK and a list of select options for the custom field, along with total_count, limit and offset

- object
  - `select_options` object[]: The list of options matching the request
    - `id` string: The unique ID of the select option
    - `value` string: The option's display value
    - `is_archived` boolean: Indicates whether the option is archived
  - `total_count` integer: Total number of options matching the filter, across all pages
  - `limit` integer: Effective page size used (echoes the request's limit, default 20)
  - `offset` integer: Effective offset used (echoes the request's offset, default 0)

## Other responses

- `400`: Returns '400 Bad Request' when custom_field_id is missing or not a valid ID, or when limit or offset is out of range.
- `401`: Returns '401 Unauthorized' when the Authorization header is missing or the API key is invalid. This response has no body.
- `404`: Returns '404 Not Found' when custom_field_id doesn't exist, or doesn't belong to the account associated with your API key.
- `405`: Returns '405 Method Not Allowed' when the request uses any HTTP method other than GET.

---

[API](https://skmtc.dev/perk/apis/custom-fields-api.md) - [All operations](https://skmtc.dev/perk/apis/custom-fields-api/llms.txt) - [OpenAPI document](https://skmtc.dev/perk/apis/custom-fields-api/revisions/767df19f2d9f?raw)