{ "info": { "_postman_id": "069ae673-e6d9-41ac-b7d4-80ac63c65473", "name": "Remote Address Details Employment Agreements API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:56.000Z", "updatedAt": "2026-07-28T02:45:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-069ae673-e6d9-41ac-b7d4-80ac63c65473" }, "item": [ { "name": "v1", "item": [ { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "employment-agreement", "item": [ { "name": "download", "item": [ { "name": "Download the Employment Agreement for an employment", "id": "46cc662b-9624-45c3-a0f3-5b392fd070d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "download" ], "variable": [ { "id": "cbbbdc27-0c27-4533-8e4b-54dfe9bb3d66", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Downloads a PDF of the auto-generated Employment Agreement for an employment.\n\nThe document is rendered as a draft (no signatures) and is not persisted. EA preview is only\navailable for countries that have a published Employment Agreement automation template \u2014 see the\n`employment_agreement_preview_available` flag on the [Countries](#tag/Countries) endpoint.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "e1c752ce-6136-4dc6-8771-f42699972b7c", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "download" ], "variable": [ { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-e1c752ce-6136-4dc6-8771-f42699972b7c" }, { "id": "9603e4b8-20c8-47f5-94d7-b0d0c69da3f4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "download" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-9603e4b8-20c8-47f5-94d7-b0d0c69da3f4" }, { "id": "e96f060b-5787-4ed6-92d4-3b411dc9dbc1", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "download" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-e96f060b-5787-4ed6-92d4-3b411dc9dbc1" }, { "id": "fcbb9cd0-f045-495a-ae07-54b0486edff7", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "download" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-fcbb9cd0-f045-495a-ae07-54b0486edff7" } ], "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-46cc662b-9624-45c3-a0f3-5b392fd070d9" } ], "id": "daa61d9c-9153-411b-814e-baf3f98b55ed", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-daa61d9c-9153-411b-814e-baf3f98b55ed" }, { "name": "preview", "item": [ { "name": "Preview the Employment Agreement for an employment", "id": "d88656ff-60db-4e47-9709-d336d964e5c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "preview" ], "variable": [ { "id": "443350f0-788d-4611-b4a8-dd7649e72126", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns a base64-encoded PDF preview of the auto-generated Employment Agreement for an employment.\n\nThe document is rendered as a draft (no signatures) and is not persisted. EA preview is only\navailable for countries that have a published Employment Agreement automation template \u2014 see the\n`employment_agreement_preview_available` flag on the [Countries](#tag/Countries) endpoint.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View documents (`document:read`) | Manage documents (`document:write`) |\n" }, "response": [ { "id": "231bcd51-1b02-4090-b3a8-d41e4e7854ad", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "preview" ], "variable": [ { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment_agreement\": {\n \"content\": \"\",\n \"name\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-231bcd51-1b02-4090-b3a8-d41e4e7854ad" }, { "id": "cd2e5a64-1ec3-45f2-bf27-bf5309bbc73c", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "preview" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-cd2e5a64-1ec3-45f2-bf27-bf5309bbc73c" }, { "id": "6fbf2162-675d-469c-b3fc-056edece33a2", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "preview" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-6fbf2162-675d-469c-b3fc-056edece33a2" }, { "id": "42ed3e71-d5cb-4830-a753-baefb3c79fc1", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/employment-agreement/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "employment-agreement", "preview" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-42ed3e71-d5cb-4830-a753-baefb3c79fc1" } ], "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-d88656ff-60db-4e47-9709-d336d964e5c5" } ], "id": "240bdd96-0c0c-43ce-8d4d-80c381b665a2", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-240bdd96-0c0c-43ce-8d4d-80c381b665a2" } ], "id": "d219f2ce-d81d-4bc8-a1a6-d8ea9007f7d0", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-d219f2ce-d81d-4bc8-a1a6-d8ea9007f7d0" } ], "id": "062dbf42-2eb8-40b2-a91e-5004b4fa2ec2", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-062dbf42-2eb8-40b2-a91e-5004b4fa2ec2" } ], "id": "54ce3487-7921-4e5a-a477-86c8d9ade75b", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-54ce3487-7921-4e5a-a477-86c8d9ade75b" } ], "id": "fe832010-7168-48c6-9faa-8e911f8cf65e", "createdAt": "2026-07-28T02:45:57.000Z", "updatedAt": "2026-07-28T02:45:57.000Z", "uid": "35240-fe832010-7168-48c6-9faa-8e911f8cf65e" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company_department:read webhook:write magic_link:write offboarding:write custom_field:write address:write expense:read employment:write identity_verification:write timesheet:write travel_letter:write incentive:read personal_detail:read invoices:write work_authorization:write timeoff:write company_structure:read benefit_renewal:write benefit_offer:read employment_documents onboarding:write payroll_run:read risk_reserve:write invoices resignation_letter:read resignation:read convert_currency:read employments probation_document:read company_admin payroll help_center_article:read timesheet:read custom_field_value:write company_currencies:read payslip:read pay_item:write resignation:write custom_field:read payroll_calendar:read contract_amendment:write offboarding:read timeoff:read probation_document:write country:read webhook:read company_department:write company_manager:read pay_item:read contract_amendment:read company:read sso_configuration:write benefit_offer:write contract_eligibility:write benefit_renewal:read background_check:read custom_field_value:read expense:write identity_verification:read address:read document:write time_and_attendance employment_payments form:read work_authorization:read invoices:read incentive:write employment:read contract:read company_manager:write travel_letter:read document:read sso_configuration:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "/auth/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://gateway.remote.com/" } ] }