Integrations
Custom Fields

Show a custom field value

Returns a custom field value for a given employment

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

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View custom field values (custom_field_value:read)Manage custom field values (custom_field_value:write)
get/v1/custom-fields/{custom_field_id}/values/{employment_id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/custom-fields/{custom_field_id}/values/{employment_id}
  • 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_value:read, custom_field_value:write, employments, all:write, all:read)

Path parameters

custom_field_idstring required

Custom field ID

employment_idstring required

Employment ID

Response

Success

Example response

{
  "data": {
    "custom_field_value": {
      "custom_field_id": "01c0e4d2-f41b-11ed-9d3f-cb3ecccebb58",
      "value": "UXH34HG"
    }
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.