Show form schema

Returns the json schema of the contract_amendment form for a specific employment.
This endpoint requires a company access token, as forms are dependent on certain
properties of companies and their current employments.

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 contract amendments (contract_amendment:read)Manage contract amendments (contract_amendment:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The ID of the employment concerned by the contract amendment request.

string
required

Country code according to ISO 3-digit alphabetic codes.

string
enum

Name of the desired form

Allowed:
≥ 1

Version of the form schema


Specific version number

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