v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Employment Contracts

Get employment contract pending changes

Get all the pending changes (waiting for aproval or signature) for the employment contract.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	View contracts (contract:read)	-

get/v1/employment-contracts/{employment_id}/pending-changes

Path parameters

employment_idstring required

Employment ID

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

Example response

{
  "data": {
    "pending_changes": [
      {
        "changes": {
          "contract.job_title": {
            "current": "Senior Engineer",
            "previous": "Engineer"
          }
        },
        "contract_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
        "effective_at": "2021-07-15T18:18:17Z"
      }
    ]
  }
}