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

# GET /custom/fields

`GET /custom/fields`

GET operation for /custom/fields

## Response `200`

Successful response

- object
  - `count` integer
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` CustomFieldSerializer[]
    - `id` integer
    - `label` string, required
    - `api_name` string
    - `description` string
    - `object` 'customer' | 'map' | 'team_member' | 'onboardee' | 'map_task' | 'task' | 'section', required
    - `type` 'number' | 'text' | 'dropdown' | 'boolean' | 'date' | 'textarea' | 'multiselect' | 'attachment', required
    - `options` object
    - `is_internal` boolean
    - `is_active` boolean
    - `created_at` string, date-time
    - `tables_display_enabled` boolean
    - `panels_display_enabled` boolean
    - `outboard_display_enabled` boolean
    - `map_types` string

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found

---

[API](https://skmtc.dev/onboard/apis/onboard-api-complete-specification.md) · [All operations](https://skmtc.dev/onboard/apis/onboard-api-complete-specification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/onboard/onboard-api-complete-specification/revisions/3d0f0a6a632d/schema)
