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

# Lists custom fields definitions

`GET /v1/custom-fields`

Returns custom fields definitions

## Scopes

| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | - | Manage custom fields (`custom_field:write`) |

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

Success

- ListEmploymentCustomFieldsResponse — Response schema listing many custom_fields
  - `data` object
    - `current_page` integer — The current page among all of the total_pages
    - `custom_fields` EmploymentCustomField[]
      - `data_entry_access` 'company_admin_only' | 'employee_only' | 'everyone', required — Who can enter or edit values for this custom field. Controls which users see the field as editable vs read-only.
      - `id` string, required — The unique identifier (UUID) of the custom field definition.
      - `metadata` object, nullable, required — Additional configuration for the field. For `single_select` fields, contains the list of selectable options. For `currency` fields, contains the currency code. Null for simple field types.
      - `name` string, required — The display name of the custom field (e.g., "Internal ID", "T-Shirt Size").
      - `required` boolean, required — Whether this custom field is required for all employments in the company.
      - `type` 'string' | 'text' | 'integer' | 'date' | 'boolean' | 'percentage' | 'decimal' | 'link' | 'currency' | 'single_select', required — The datatype of the custom field
      - `visibility_scope` 'company_admin_only' | 'everyone', required — Who can see this custom field and its values. Controls visibility across different user roles.
    - `total_count` integer — The total number of records in the result
    - `total_pages` integer — The total number of pages the user can go through

## Other responses

- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/remote-com/apis/remote.md) · [All operations](https://skmtc.net/remote-com/apis/remote/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/remote-com/remote/versions/7e6a0c61ac82/schema)