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

# List custom fields

`GET /custom-fields/`

Endpoint for retrieving a list of custom fields.

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

- PaginatedapiV1ExternalCustomFieldReadList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` ApiV1ExternalCustomFieldRead[], required
    - `apply_to` ApplyToEnum[], required — The groups this custom field applies to.
    - `config` union, required — The configuration of the custom field, containing field_type and metadata. The metadata structure depends on field_type: SELECT fields include a choices array, LOOKUP fields include an entity_type, and other types have empty metadata.
      - CustomFieldSelectModel
        - `field_type` 'SELECT', required
        - `metadata` CustomFieldSelectMetadataModel, required
          - `choices` ChoiceModel[], required
            - `label` string, required
            - `value` string
      - CustomFieldNumberModel
        - `field_type` 'NUMBER', required
        - `metadata` CustomFieldNumberMetadataModel
      - CustomFieldTextModel
        - `field_type` 'TEXT', required
        - `metadata` CustomFieldTextMetadataModel
      - CustomFieldLongTextModel
        - `field_type` 'LONG_TEXT', required
        - `metadata` CustomFieldLongTextMetadataModel
      - CustomFieldDateModel
        - `field_type` 'DATE', required
        - `metadata` CustomFieldDateMetadataModel
      - CustomFieldLookupModel
        - `field_type` 'LOOKUP', required
        - `metadata` CustomFieldLookupMetadataModel, required
          - `entity_type` 'EMPLOYEE' | 'USER', required
      - CustomFieldCalculatedModel
        - `field_type` 'CALCULATED', required
        - `metadata` CustomFieldCalculatedMetadataModel, required
          - `operands` string[], required
          - `operator` 'MULTIPLY', required
    - `created_ts` string, date-time, required — The timestamp in UTC when the custom field was created.
    - `field_type` 'TEXT' | 'LONG_TEXT' | 'NUMBER' | 'DATE' | 'SELECT' | 'LOOKUP' | 'CALCULATED', required — * `TEXT` - TEXT * `LONG_TEXT` - LONG_TEXT * `NUMBER` - NUMBER * `DATE` - DATE * `SELECT` - SELECT * `LOOKUP` - LOOKUP * `CALCULATED` - CALCULATED Full information for [FieldTypeEnum](fieldtypeenum)
    - `id` string, required — The unique identifier of the custom field.
    - `is_active` boolean
    - `is_line_item_field` boolean
    - `modified_ts` string, date-time, required — The timestamp in UTC when the custom field was last modified.
    - `name` string
    - `name_ar` string

---

[API](https://skmtc.net/wafeq/apis/wafeq-public-api.md) · [All operations](https://skmtc.net/wafeq/apis/wafeq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wafeq/wafeq-public-api/versions/36816b4fce7f/schema)