---
title: "List custom columns"
method: GET
path: "/v1/custom_columns"
tags: ["Custom column"]
---

# List custom columns

`GET /v1/custom_columns`

## Request

- Base URL: `https://api.cardda.com`
- URL: `https://api.cardda.com/v1/custom_columns`
- Auth: HTTP bearer

Returns a paginated list of custom columns for the companies the caller belongs to. Custom
columns define the configurable rendición (expense-tracking) fields attached to transactions
and other applicable models. Results are scoped to the caller's company memberships.

## Query parameters

- `_start` integer
- `_end` integer
- `_order` 'asc' | 'desc'
- `_field` string
- `applicable_models` string

## Headers

- `company-id` string, uuid, required

## Response `200`

Paginated list of custom columns

- CustomColumn[]
  - `id` string, uuid, required
  - `company_id` string, uuid, required
  - `label` string: Human-facing label shown in the UI.
  - `internal_name` string, nullable: Internal name used for programmatic references.
  - `field` string: The field/input type of the column. `options` drives a select-style column with a fixed set of choices.
  - `source_table` string, nullable: The source table the column reads from, when applicable.
  - `default_value` string, nullable: Default value applied when no value is set.
  - `applicable_models` string[]: The models this column applies to (e.g. `transactions`, `card_transactions`, `payables`).
  - `options` object[]: For option-type columns, the allowed key/value choices.
    - `key` string
    - `value` string
  - `required_on_purchase_orders` boolean: Whether a purchase order cannot be requested without this column. Only valid on a column whose `applicable_models` include `purchase_orders` (422 otherwise); removing `purchase_orders` from them later switches it off. Only honoured when the caller has `custom_columns_manage`: without it, it is silently dropped. Applies on create (the order must be born with a value) and on edit (a value cannot be emptied); orders that already existed are not changed.
  - `created_at` string, date-time
  - `updated_at` string, date-time

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/cardda/apis/accounting-api.md) - [All operations](https://skmtc.dev/cardda/apis/accounting-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cardda/apis/accounting-api/revisions/49cf78d0f7ab?raw)