Remote Custom Fields API declares
7 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
It accepts HTTP bearer tokens (ClientToken).
It accepts HTTP bearer tokens (CustomerAPIToken).
It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes.
It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes.
It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes.
It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes.
By default, every request must be authenticated.
BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
OAuth2 — Authenticate using OAuth 2.0 protocol.
OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are EmploymentCustomField (7 properties), CreateSingleSelectCustomFieldDefinitionParams (6 properties), CreateCurrencyCustomFieldDefinitionParams (6 properties), CreateGeneralCustomFieldDefinitionParams (5 properties). Each schema is shown below with its type and property counts.
CreateSingleSelectCustomFieldDefinitionParams
object
Schema for creating a single select custom field definition
6 properties6 required
ParameterError
object
3 properties3 required
ListEmploymentCustomFieldsResponse
object
Response schema listing many customfields
1 property
SingleSelectMetadata
object
The metadata for a single select custom field
1 property1 required
ListEmploymentCustomFieldValuePaginatedResponse
object
Response schema listing many customfieldvalues
1 property
EmploymentCustomFieldValueResponse
object
Response containing a single custom field value for an employment.
1 property1 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property1 required
UnprocessableEntityResponse
object
CurrencyCode
string
Currency code of the SWIFT fee. Only present when processingfee is set.
CreateCurrencyCustomFieldDefinitionParams
object
Schema for creating a currency custom field definition
6 properties6 required
CustomFieldDataType
string
The datatype of the custom field
ListEmploymentCustomFieldValueResponse
object
A custom field value as returned in list responses, including the field definition details alongside the value.
4 properties4 required
ActionError
object
3 properties3 required
EmploymentCustomFieldValue
object
The value of a custom field for a specific employment. The type of value depends on the custom field's data type.
2 properties2 required
CustomFieldSimpleDataType
string
The datatype of the custom field
UpdateEmploymentCustomFieldValueParams
object
Schema for updating a custom field value.
1 property1 required
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property1 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
CustomFieldVisibilityScope
string
Who can see this custom field and its values. Controls visibility across different user roles.
EmploymentCustomField
object
A custom field definition that can be applied to employments within a company. Custom fields allow you to store additional structured data on employments beyon…
7 properties7 required
CustomFieldDataEntryAccess
string
Who can enter or edit values for this custom field. Controls which users see the field as editable vs read-only.
CreateCustomFieldDefinitionParams
Schema for creating a custom field definition
EmploymentCustomFieldValueJsonValue
object
The value for a single-select custom field, containing both the option ID and its human-readable label.
2 properties2 required
CreateEmploymentCustomFieldResponse
object
Response returned after successfully creating a new custom field definition.
1 property1 required
CreateGeneralCustomFieldDefinitionParams
object
Schema for creating a general custom field definition
5 properties5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
