Remote Custom Fields API

Customer-defined fields on companies and employments

Operations 4

GET /custom_fields List Custom Field Definitions #
POST /custom_fields Create A Custom Field Definition #
GET /custom_fields/{custom_field_id}/values List Custom Field Values #
PUT /custom_fields/{custom_field_id}/values Upsert A Custom Field Value #

Documentation

📖
Documentation
https://developer.remote.com/reference/welcome-to-remote-api
📖
Documentation
https://developer.remote.com/docs/creating-a-company
📖
Documentation
https://developer.remote.com/docs/create-new-employment
📖
Documentation
https://developer.remote.com/docs/employment-lifecycle-stages
📖
Documentation
https://developer.remote.com/docs/employment-statuses
📖
Documentation
https://developer.remote.com/docs/quick-start-guide-2
📖
Documentation
https://developer.remote.com/docs/working-with-expenses
📖
Documentation
https://developer.remote.com/docs/working-with-incentives
📖
Documentation
https://developer.remote.com/docs/working-with-time-off
📖
Documentation
https://developer.remote.com/docs/leave-policies-summary
📖
Documentation
https://developer.remote.com/docs/working-with-timesheets
📖
Documentation
https://developer.remote.com/docs/benefits-renewal
📖
Documentation
https://developer.remote.com/docs/working-with-files
📖
Documentation
https://developer.remote.com/docs/custom-fields
📖
Documentation
https://developer.remote.com/docs/working-with-countries
📖
Documentation
https://developer.remote.com/docs/employment-cost-estimation
📖
Documentation
https://developer.remote.com/docs/authentication
📖
Documentation
https://developer.remote.com/docs/authorization-for-customers
📖
Documentation
https://developer.remote.com/docs/client-credentials-flow-for-partners
📖
Documentation
https://developer.remote.com/docs/authorization-method-oauth-assertion
📖
Documentation
https://developer.remote.com/docs/refresh-token-flow

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/remote-com-custom-fields-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

remote-com-custom-fields-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Remote Benefits Benefit Offers Custom Fields API
  description: 'List, select, and renew localized employee benefits across the countries

    Remote supports. Benefit offers and renewal requests use JSON Schema

    forms that vary per country and employment.

    '
  version: '2026-05-22'
  contact:
    name: Remote API Support
    url: https://support.remote.com/
  x-logo:
    url: https://remote.com/favicon.ico
servers:
- url: https://gateway.remote.com/v1
  description: Production
- url: https://gateway.remote-sandbox.com/v1
  description: Sandbox
security:
- BearerAuth: []
tags:
- name: Custom Fields
  description: Customer-defined fields on companies and employments
paths:
  /custom_fields:
    get:
      summary: List Custom Field Definitions
      operationId: listCustomFieldDefinitions
      tags:
      - Custom Fields
      parameters:
      - name: scope
        in: query
        schema:
          type: string
          enum:
          - company
          - employment
      responses:
        '200':
          description: Custom field definitions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      custom_fields:
                        type: array
                        items:
                          $ref: '#/components/schemas/CustomFieldDefinition'
    post:
      summary: Create A Custom Field Definition
      operationId: createCustomFieldDefinition
      tags:
      - Custom Fields
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldDefinition'
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      custom_field:
                        $ref: '#/components/schemas/CustomFieldDefinition'
  /custom_fields/{custom_field_id}/values:
    parameters:
    - name: custom_field_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      summary: List Custom Field Values
      operationId: listCustomFieldValues
      tags:
      - Custom Fields
      parameters:
      - name: subject_id
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Values.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      values:
                        type: array
                        items:
                          $ref: '#/components/schemas/CustomFieldValue'
    put:
      summary: Upsert A Custom Field Value
      operationId: upsertCustomFieldValue
      tags:
      - Custom Fields
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldValue'
      responses:
        '200':
          description: Upserted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      value:
                        $ref: '#/components/schemas/CustomFieldValue'
components:
  schemas:
    CustomFieldDefinition:
      type: object
      required:
      - name
      - scope
      - type
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        scope:
          type: string
          enum:
          - company
          - employment
        type:
          type: string
          enum:
          - string
          - number
          - boolean
          - date
          - enum
          - multiselect
        options:
          type: array
          items:
            type: string
          description: For enum/multiselect types.
        required:
          type: boolean
          default: false
        description:
          type: string
    CustomFieldValue:
      type: object
      required:
      - subject_id
      - value
      properties:
        id:
          type: string
          format: uuid
        custom_field_id:
          type: string
          format: uuid
        subject_id:
          type: string
          format: uuid
        value:
          oneOf:
          - type: string
          - type: number
          - type: boolean
          - type: array
            items:
              type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT