---
title: "List custom field value for an employment"
method: GET
path: "/v1/employments/{employment_id}/custom-fields"
tags: ["Custom Fields"]
---

# List custom field value for an employment

`GET /v1/employments/{employment_id}/custom-fields`

Returns a list of custom field values for a given employment

## Scopes

| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) |

## Path parameters

- `employment_id` string, required

## Query parameters

- `page` integer
- `page_size` integer

## Response `200`

Success

- ListEmploymentCustomFieldValuePaginatedResponse — Response schema listing many custom_field_values
  - `data` object
    - `current_page` integer — The current page among all of the total_pages
    - `custom_field_values` ListEmploymentCustomFieldValueResponse[]
      - `custom_field_id` string, required — The unique identifier (UUID) of the custom field definition.
      - `name` string, required — The display name of the custom field.
      - `type` string, required — The data type of the custom field (e.g., "string", "integer", "single_select").
      - `value` union, required
        - string
        - integer
        - boolean
        - number — Decimal value represented as a String
        - EmploymentCustomFieldValueJsonValue — The value for a single-select custom field, containing both the option ID and its human-readable label.
          - `selected_option` string, required — The unique identifier of the selected option.
          - `selected_option_label` string, required — The human-readable label of the selected option (e.g., "XL").
    - `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/revisions/7e6a0c61ac82/schema)