Employments
Pre-Onboarding Requirements

List pre-onboarding requirements for an employment

Changed on

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).

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite 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

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/onboarding/employments/{employment_id}/pre-onboarding-requirements
  • 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, document:read, document:write, employment_documents, all:write, all:read)

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"
    }
  ]
}

Changes