v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Contract Amendments

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.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	View contract amendments (contract_amendment:read)	Manage contract amendments (contract_amendment:write)

get/v1/contract-amendments/schema

Query parameters

employment_idstring required

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

country_codestring required

Country code according to ISO 3-digit alphabetic codes.

form'contract_amendment'

Name of the desired form

integer

Specific version number

'latest'

Use latest version

Version of the form schema

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

dataobject

Example response

{
  "data": {
    "additionalProperties": false,
    "properties": {
      "effective_date": {
        "description": "If you want to backdate this amendment, we cannot guarantee your preferred date is possible due to country-specific laws.\nPlease enter your preferred date, and we’ll reach out to you if there are any issues.\n",
        "title": "Effective date of change",
        "type": "date"
      },
      "job_title": {
        "description": "What is their job title? E.g. Product designer",
        "maxLength": 255,
        "title": "Job title",
        "type": "string"
      }
    },
    "required": [
      "job_title",
      "effective_date"
    ],
    "type": "object"
  }
}