---
title: "List Custom Fields"
method: GET
path: "/transactions/custom-fields"
tags: ["Custom Fields"]
---

# List Custom Fields

`GET /transactions/custom-fields`

Returns a list of all [custom fields](/docs/custom-fields-on-transactions) for the given organization. [Custom fields](/docs/custom-fields-on-transactions) can be created by the organization via the Pliant web app or API. Those fields can be used to store additional information on transactions, e.g. an additional field needed for pre-accounting purposes, or a reference the organizations needs to reconciliation processes later in their systems. [Custom fields](/docs/custom-fields-on-transactions) can be set on card- or transaction-level. If set on card-level, each transaction made with this card gets a copy of the custom field values of the respective card.

## Query parameters

- `organizationId` string, uuid, required
- `limit` integer
- `page` integer

## Response `200`

Ok

- object
  - `data` object[]
    - `id` string, uuid — The id of the custom field.
    - `label` string — The label of the custom field, displayed in a UI for example.
    - `description` string, nullable — The description of the custom field, displayed in a UI for example.
    - `defaultValue` string, nullable — The default value of the custom field, optional.
    - `type` 'TEXT' | 'SELECT' — The type of the custom field. `TEXT` represents a custom field which can store any text value. `SELECT` represents a custom field which can store a fixed set of options.
    - `status` 'ACTIVE' | 'INACTIVE' — The status of the custom field. Only an active custom field can be used.
    - `automationType` 'CARD' — The automation type of the custom field. For now only `CARD` is supported. This means, that the [custom fields](/docs/custom-fields-on-transactions) default value will be copied to every transaction made with the card the field is set on.
    - `mandatoryOnAutomation` boolean — If set to true, this means this custom field is mandatory to be filled with a default value on the level of the automation, here `CARD`.
    - `mandatoryForExport` boolean — If set to true, this means this custom field is mandatory to be filled on every transaction which should be exported with the Pliant accounting export.
    - `visibility` 'ADMIN_AND_CARDHOLDER' | 'ADMIN_ONLY' | 'NOWHERE' — Controls where the values of this custom field are visible. `ADMIN_AND_CARDHOLDER` makes the values visible to both admins and cardholders. `ADMIN_ONLY` makes the values visible only to admins. `NOWHERE` hides the values from both admins and cardholders.
    - `createdAt` string, date-time — The date and time the custom field was created.
    - `updatedAt` string, date-time, nullable — The date and time the custom field 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)