Create Custom Field Definition

Creates a new custom field definition.

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.
  • 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.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employments (employments)-Manage custom fields (custom_field:write)
Company-scoped access token (assertion)Manage employments (employments)-Manage custom fields (custom_field:write)
Customer API tokenManage employments (employments)-Manage custom fields (custom_field:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Custom Field Definition Create Parameters

Schema for creating a general custom field definition

string
enum
required

Who can enter or edit values for this custom field. Controls which users see the field as editable vs read-only.

Allowed:
string
required
boolean
required
string
enum
required

The datatype of the custom field

string
enum
required

Who can see this custom field and its values. Controls visibility across different user roles.

Allowed:
Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json