Contracts
Employment Agreements

Preview the Employment Agreement for an employment

Returns a base64-encoded PDF preview of the auto-generated Employment Agreement for an employment.

The document is rendered as a draft (no signatures) and is not persisted. EA preview is only available for countries that have a published Employment Agreement automation template — see the employment_agreement_preview_available flag on the Countries endpoint.

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/employments/{employment_id}/employment-agreement/preview

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employments/{employment_id}/employment-agreement/preview
  • 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": {
    "employment_agreement": {
      "content": "data:application/pdf;base64,iVBORw0KGgoAAAANSUhEUgAAAJUAAACVCAYAAABRorhPAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWF...",
      "name": "employment_agreement.pdf"
    }
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.