Contract Amendments
List Contract Amendment
List Contract Amendment requests.
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
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/contract-amendments
- 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)
Query parameters
employment_idstring
Employment ID
status'submitted' | 'in_review' | 'done' | 'canceled' | 'deleted'
The current status of a contract amendment request.
- submitted: The amendment has been submitted and is awaiting Remote's review.
- in_review: Remote is reviewing the amendment for compliance and feasibility.
- done: The amendment has been approved and applied to the contract.
- canceled: The amendment request was canceled before completion.
- deleted: The amendment request was deleted.
Example:submitted
Contract Amendment status
pageinteger
Starts fetching records after the given page
page_sizeinteger
Number of items per page
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
{
"contract_amendments": [
{
"employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
"id": "ba310525-9282-40c9-8977-14d844bf891a",
"job_title": "Engineer",
"reason_for_change": "annual_pay_adjustment",
"requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
"requested_effective_date": "2023-04-13T13:35:06Z",
"status": "submitted",
"submitted_at": "2023-04-13T13:35:06Z"
}
],
"current_page": 1,
"total_count": 1,
"total_pages": 1
}Changes
No recorded changes to this operation across all 1 revision of this API.