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

# List custom fields

`GET /v1/custom-fields`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/custom-fields`
- Auth: API key in header `x-api-key`

Returns every custom field definition for the organization in display order. An organization defines at most 100, so the list is never paged.

## Response `200`

CustomFieldList

- CustomFieldList
  - `items` object[], required
    - `id` string, required
    - `organizationId` string, required
    - `key` string, required
    - `label` string, required
    - `type` 'text' | 'number' | 'boolean' | 'date' | 'select', required
    - `options` string[], nullable, required
    - `defaultValue` string, nullable, required
    - `isRequired` boolean, required
    - `sortOrder` integer, required
    - `createdAt` string, required
    - `updatedAt` string, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

[API](https://skmtc.dev/samva/apis/samva-api.md) · [All operations](https://skmtc.dev/samva/apis/samva-api/llms.txt) · [OpenAPI document](https://skmtc.dev/samva/apis/samva-api/revisions/a99408542cc3?raw)