Contracts
Employment Agreements
Download the Employment Agreement for an employment
Downloads a PDF 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
| 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/employments/{employment_id}/employment-agreement/download
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/employments/{employment_id}/employment-agreement/download
- 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
string binary required
A file represented as a base64-encoded string.
Example response
"base64 encoded content"
Changes
No recorded changes to this operation across all 65 revisions of this API.