Contract Amendments
Show Contract Amendment
Show a single Contract Amendment request.
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/{id}
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/contract-amendments/{id}
- Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, contract_amendment:read, contract_amendment:write, employments, all:write, all:read)
Path parameters
idstring required
Contract amendment request 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": {
"contract_amendment": {
"amendment_contract_id": "8772a9f1-b43c-46be-a1ce-e50b6819f5ee",
"changes": {
"compensation.amount": {
"current": 500000,
"previous": 400000
},
"contract.job_title": {
"current": "A new job title",
"previous": "An old job title"
},
"contract_details.details.contract_duration_type": {
"current": "fixed_term",
"previous": "indefinite"
}
},
"employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
"id": "ba310525-9282-40c9-8977-14d844bf891a",
"request_details": {
"additional_comments": null,
"effective_date": "2024-03-04",
"reason_for_change": "annual_pay_adjustment",
"reason_for_change_description": null,
"salary_decrease_details": null
},
"requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
"status": "submitted",
"submitted_at": "2023-04-13T13:35:06Z",
"zendesk_ticket_url": "https://zendesk.com/ticket-23333"
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.