---
title: "Reads all Fields"
method: GET
path: "/api/2026-10-01/resources/custom_fields/fields"
tags: ["CustomFields > Field"]
---

# Reads all Fields

`GET /api/2026-10-01/resources/custom_fields/fields`

## Request

- Base URL: `https://api.factorialhr.com`
- URL: `https://api.factorialhr.com/api/2026-10-01/resources/custom_fields/fields`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.factorialhr.com/oauth/authorize`
    - Token URL: `https://id.factorialhr.com/api/oauth/token` scopes: `custom_fields`
  - API key in header `x-api-key`

Reads all Fields

## Query parameters

- `ids[]` string[]: Field identifiers
- `field_type` 'text' | 'long_text' | 'date' | 'rating' | 'checkbox' | 'single_choice' | 'multiple_choice' | 'money' | 'cents': Filter fields by type
- `label` string: Field label
- `slug` string: Custom field slug
- `company_id` string: Company identifier where this field belongs

## Response `200`

OK

- object
  - `data` CustomFieldsField[]
    - `id` string, required: Field identifier
    - `field_type` 'text' | 'long_text' | 'date' | 'rating' | 'checkbox' | 'single_choice' | 'multiple_choice' | 'money' | 'cents', required: The type of the field's value
    - `label_text` string, required: Field label
    - `position` integer: Field position within employee profile
    - `required` boolean: Requirement to fill this field
    - `min_value` integer: Minimum value in range field type
    - `max_value` integer: Maximum value in range field type
    - `legal_entity_name` string: Legal entity name where this field belongs
    - `legal_entity_id` string: Legal entity id where this field belongs
    - `slug` string: Custom field slug
  - `meta` PagedIndexMeta
    - `start_cursor` string
    - `end_cursor` string
    - `has_previous_page` boolean, required
    - `has_next_page` boolean, required
    - `limit` integer, required
    - `total` integer, required

## Changes

- **2026-11-03** `83ac9aa1de50`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/factorialhr/apis/factorial-api/changes/api/2026-10-01/resources/custom_fields/fields/get.md)

---

[API](https://skmtc.dev/factorialhr/apis/factorial-api.md) - [All operations](https://skmtc.dev/factorialhr/apis/factorial-api/llms.txt) - [OpenAPI document](https://skmtc.dev/factorialhr/apis/factorial-api/revisions/83ac9aa1de50?raw)
