---
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`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/employments/{employment_id}/custom-fields`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `custom_field_value:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `custom_field_value:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

Returns a list of custom field values for a given employment

## Authentication

This endpoint accepts any one of the following token types:

- **Company-scoped access token** (`OAuth2AuthorizationCode`) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).
- **Company-scoped access token (assertion)** (`OAuth2CompanyManagerAssertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant for a company manager. See [OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion).
- **Customer API token** (`CustomerAPIToken`) — generated by the customer on their Integration Settings page, with the scopes they choose there. See [Authorization for customers](https://developer.remote.com/docs/authorization-for-customers).

## Scopes

Any one of the scopes in a token type's row is enough. `all:read` and `all:write` work too.

| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) |
| Company-scoped access token (assertion) | Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) |
| Customer API token | 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.dev/remote-com/apis/integrations.md) - [All operations](https://skmtc.dev/remote-com/apis/integrations/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/integrations/revisions/1798c3c003d5?raw)