v1
latestOpenAPI 3.1.02026-07-242735131.1 MBPre-Onboarding Requirements
List pre-onboarding requirements for an employment
Returns the list of pre-onboarding requirements — both documents (e.g. master service agreements, individual labour agreements) and acknowledgements — that must be fulfilled before the given employment can be onboarded. Each requirement carries its type, current status, and the requirement it depends_on (if any).
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (employment_documents) | View documents (document:read) | Manage documents (document:write) |
get/v1/onboarding/employments/{employment_id}/pre-onboarding-requirements
Path parameters
employment_idstring required
Employment ID
Response
Success
Example response
{
"data": [
{
"depends_on_requirement": null,
"description": "Agreement governing the overall terms of service for the engagement.",
"freeze_employment_data": true,
"name": "Master Service Agreement",
"redlining_help_email": "redlining-help@remote.com",
"slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
"status": "awaiting",
"supports_redlining": true,
"type": "document"
}
]
}