Lists custom fields definitions

Changed on Sep 2, 2026

Returns custom fields definitions

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

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

get/v1/custom-fields

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/custom-fields
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, custom_field:read, custom_field:write, employments, all:write, all:read)

Query parameters

company_idstring

The company the accessed resource belongs to. Send it whenever you know which one you mean. Requests that don't resolve to a company fail with "Company not found".

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "custom_fields": [
    {
      "data_entry_access": "company_admin_only",
      "id": "01c0e4d2-f41b-11ed-9d3f-cb3ecccebb58",
      "metadata": {},
      "name": "Internal ID",
      "required": true,
      "type": "string",
      "visibility_scope": "everyone"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

Sep 2, 202616ae80499bdb Revision changes
- info
  the security scope all:read was added to the endpoint's security scheme CustomerAPIToken
- info
  the security scope all:read was added to the endpoint's security scheme OAuth2AuthorizationCode
- info
  the security scope custom_field:read was added to the endpoint's security scheme CustomerAPIToken
- info
  the security scope custom_field:read was added to the endpoint's security scheme OAuth2AuthorizationCode
- info
  added the new optional query request parameter company_id

Operation history