v1

latestOpenAPI 3.0.1MIT2026-07-261190449.2 KB
Custom Fields

List Custom Field Options

Returns a list of all custom field options for the given custom field. Custom field options 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.

get/transactions/custom-fields/{customFieldId}/options

Path parameters

customFieldIdstring uuid required

The unique identifier of the custom field for which you want to list the possible options. The custom field has to be of type SELECT.

Query parameters

fromDatestring date-time
Example:2024-07-19T15:00:00.000000Z

The from date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.

toDatestring date-time
Example:2024-07-19T15:00:00.000000Z

The to date to filter by as zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.

byDateField'createdAt' | 'updatedAt' nullable

The date field to filter by if fromDate and toDate are present.

limitinteger

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

pageinteger

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy'createdAt' | 'updatedAt'

The field to sort by.

sortDirection'ASC' | 'DESC'

The direction to sort by.

Response

Ok

hasNextPageboolean

Indicates whether there is a next page available.