---
title: "List Custom Field Options"
method: GET
path: "/transactions/custom-fields/{customFieldId}/options"
tags: ["Custom Fields"]
---

# List Custom Field Options

`GET /transactions/custom-fields/{customFieldId}/options`

Returns a list of all [custom field options](/docs/custom-fields-on-transactions) for the given custom field. [Custom field options](/docs/custom-fields-on-transactions) can be edited by the organization via the Pliant web app or API. Options give you the flexibility to define a fixed set of options a custom field can have. This can be useful for example if you want to restrict the values a customer can use.

## Path parameters

- `customFieldId` string, uuid, required

## Query parameters

- `fromDate` string, date-time
- `toDate` string, date-time
- `byDateField` 'createdAt' | 'updatedAt', nullable
- `limit` integer
- `page` integer
- `sortBy` 'createdAt' | 'updatedAt'
- `sortDirection` 'ASC' | 'DESC'

## Response `200`

Ok

- object
  - `data` object[]
    - `id` string, uuid — The id of the custom field option.
    - `customFieldId` string, uuid — The id of the custom field this option belongs to.
    - `name` string — The name of the custom field option, readable for humans.
    - `value` string — The value of the custom field option. This is mostly your internal value you want to process.
    - `status` 'ACTIVE' | 'INACTIVE' — The status of the custom field option. Only an active custom field option can be used.
    - `isDefault` boolean — If set to true, this means this custom field option is the default option for the related custom field.
    - `createdAt` string, date-time — The date and time the custom field option was created.
    - `updatedAt` string, date-time — The date and time the custom field option was last updated.
  - `hasNextPage` boolean — Indicates whether there is a next page available.

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `403` — unresolved $ref
- `429` — unresolved $ref
- `500` — unresolved $ref

---

[API](https://skmtc.dev/getpliant/apis/pliant-customer-api.md) · [All operations](https://skmtc.dev/getpliant/apis/pliant-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getpliant/pliant-customer-api/revisions/f3f589cfa718/schema)