v1
latestOpenAPI 3.1.02026-07-242735131.1 MBEmployment Contracts
List Employment Contract.
Get the employment contract history for a given employment. If only_active is true, it will return only the active or last active contract.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (employments) | View contracts (contract:read) | - |
get/v1/employment-contracts
Query parameters
employment_idstring required
Employment ID
only_activeboolean
Only Active
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": {
"employment_contracts": [
{
"activated_at": "2021-07-15T18:18:17Z",
"amendment_contract_id": "e31adae1-contract-id-af5fba7dd803",
"compensation": {
"amount": 33000,
"currency_code": "CAD",
"wage_type": "salary"
},
"contract_details": {},
"contract_id": "20a72f86-contract-id-9e4942a902ff",
"country": {
"alpha_2_code": "PT",
"code": "PRT",
"contractor_products_available": [
"standard",
"plus",
"cor"
],
"country_subdivisions": [
{
"code": "PT-06",
"name": "Coimbra",
"subdivision_type": "District"
},
{
"code": "PT-11",
"name": "Lisboa",
"subdivision_type": "District"
}
],
"employment_agreement_preview_available": true,
"eor_onboarding": true,
"locked_benefits": "after_first_hire",
"name": "Portugal",
"region": "Europe",
"subregion": "Southern Europe",
"supported_json_schemas": [
"additional_documents",
"address_details",
"administrative_details",
"employment-basic-information",
"bank_account_details",
"contract_details",
"emergency_contact"
]
},
"effective_at": "2021-07-15T18:18:17Z",
"job_title": "Engineer",
"status": "active"
}
]
}
}