{ "info": { "_postman_id": "5c3307fb-7979-4e01-a792-3211bc506507", "name": "Remote Address Details Contracts API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "lastUpdatedBy": "35240", "uid": "35240-5c3307fb-7979-4e01-a792-3211bc506507" }, "item": [ { "name": "v1", "item": [ { "name": "contract-amendments", "item": [ { "name": "schema", "item": [ { "name": "Show form schema", "id": "d0406e57-3692-4a57-8ce2-7930af7ea86c", "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/contract-amendments/schema?employment_id=&country_code=&form=contract_amendment&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "schema" ], "query": [ { "description": "(Required) The ID of the employment concerned by the contract amendment request.", "key": "employment_id", "value": "" }, { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "Name of the desired form", "key": "form", "value": "contract_amendment" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Returns the json schema of the `contract_amendment` form for a specific employment.\nThis endpoint requires a company access token, as forms are dependent on certain\nproperties of companies and their current employments.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) |\n" }, "response": [ { "id": "d6b15637-1407-4308-8c12-7d76cd5d5ef7", "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/contract-amendments/schema?employment_id=&country_code=&form=contract_amendment&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "schema" ], "query": [ { "description": "(Required) The ID of the employment concerned by the contract amendment request.", "key": "employment_id", "value": "" }, { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "Name of the desired form", "key": "form", "value": "contract_amendment" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-d6b15637-1407-4308-8c12-7d76cd5d5ef7" }, { "id": "2bd2e2cc-a937-42bd-a18f-038d036a6ca5", "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/contract-amendments/schema?employment_id=&country_code=&form=contract_amendment&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "schema" ], "query": [ { "description": "(Required) The ID of the employment concerned by the contract amendment request.", "key": "employment_id", "value": "" }, { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "Name of the desired form", "key": "form", "value": "contract_amendment" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-2bd2e2cc-a937-42bd-a18f-038d036a6ca5" }, { "id": "96542114-c4b6-44cc-8dc1-9d5af7cb479b", "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/contract-amendments/schema?employment_id=&country_code=&form=contract_amendment&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "schema" ], "query": [ { "description": "(Required) The ID of the employment concerned by the contract amendment request.", "key": "employment_id", "value": "" }, { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "Name of the desired form", "key": "form", "value": "contract_amendment" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-96542114-c4b6-44cc-8dc1-9d5af7cb479b" }, { "id": "55c308b8-e9a2-445f-bab5-6f7a25658350", "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/contract-amendments/schema?employment_id=&country_code=&form=contract_amendment&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "schema" ], "query": [ { "description": "(Required) The ID of the employment concerned by the contract amendment request.", "key": "employment_id", "value": "" }, { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "Name of the desired form", "key": "form", "value": "contract_amendment" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-55c308b8-e9a2-445f-bab5-6f7a25658350" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-d0406e57-3692-4a57-8ce2-7930af7ea86c" } ], "id": "da6fc350-9378-4314-ab39-aabe9b8d89dd", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-da6fc350-9378-4314-ab39-aabe9b8d89dd" }, { "name": "{id}", "item": [ { "name": "Show Contract Amendment", "id": "a8bddd9c-ba26-49d7-9e9e-acd7c1267239", "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/contract-amendments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", ":id" ], "variable": [ { "id": "5ef1787c-c584-47d3-b1d5-2285933c75f4", "key": "id", "value": "", "description": "(Required) Contract amendment request ID" } ] }, "description": "Show a single Contract Amendment request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) |\n" }, "response": [ { "id": "afff531d-069d-404f-b73e-bf03be1f7268", "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/contract-amendments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"contract_amendment\": {\n \"id\": \"\",\n \"amendment_contract_id\": \"\",\n \"employment_id\": \"\",\n \"status\": \"submitted\",\n \"requested_by\": \"\",\n \"submitted_at\": \"\",\n \"request_details\": {\n \"additional_comments\": \"\",\n \"effective_date\": \"\",\n \"reason_for_change\": \"error_correction\",\n \"reason_for_change_description\": \"\",\n \"salary_decrease_details\": {\n \"salary_decrease_reason\": \"change_in_working_hours\",\n \"salary_decrease_reason_description\": \"\",\n \"was_employee_informed\": \"\"\n }\n },\n \"changes\": {},\n \"zendesk_ticket_url\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-afff531d-069d-404f-b73e-bf03be1f7268" }, { "id": "f09721d1-b039-4ef8-bbf9-e61cdd225ada", "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/contract-amendments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-f09721d1-b039-4ef8-bbf9-e61cdd225ada" }, { "id": "6776d0a8-a8a7-44c1-b727-362450dfdc41", "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/contract-amendments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-6776d0a8-a8a7-44c1-b727-362450dfdc41" }, { "id": "df19929c-8da9-4a7c-a838-344e75bbb74e", "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/contract-amendments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-df19929c-8da9-4a7c-a838-344e75bbb74e" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-a8bddd9c-ba26-49d7-9e9e-acd7c1267239" } ], "id": "f2c4c74b-5dfd-4f88-9a21-f22c5fccbe11", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-f2c4c74b-5dfd-4f88-9a21-f22c5fccbe11" }, { "name": "automatable", "item": [ { "name": "Automatable Contract Amendment", "id": "1adb3006-a6f5-4206-a6ec-0b0f1757aac5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments/automatable?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "automatable" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Check if a contract amendment request is automatable.\nIf the contract amendment request is automatable, then after submission, it will instantly amend the employee's contract\nand send them an updated document.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Contract Amendments](#tag/Contract-Amendments) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) |\n" }, "response": [ { "id": "0bdbbed7-5e55-4d31-bc5d-18b4ee46ae5e", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments/automatable?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "automatable" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"automatable\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-0bdbbed7-5e55-4d31-bc5d-18b4ee46ae5e" }, { "id": "0b77f3f8-bd64-468f-9cda-b936d033b17e", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments/automatable?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "automatable" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-0b77f3f8-bd64-468f-9cda-b936d033b17e" }, { "id": "c7fcd13f-818c-4305-b452-3aa9943f3847", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments/automatable?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "automatable" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-c7fcd13f-818c-4305-b452-3aa9943f3847" }, { "id": "9f9b32de-bab0-4c8d-bc81-e801d1fd9a51", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments/automatable?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments", "automatable" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-9f9b32de-bab0-4c8d-bc81-e801d1fd9a51" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-1adb3006-a6f5-4206-a6ec-0b0f1757aac5" } ], "id": "0c17a94b-bea7-411b-885c-52cab161d593", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-0c17a94b-bea7-411b-885c-52cab161d593" }, { "name": "List Contract Amendment", "id": "3272f58c-1f0c-4010-98cf-6f2277c30d4a", "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/contract-amendments?employment_id=&status=canceled&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Contract Amendment status", "key": "status", "value": "canceled" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "List Contract Amendment requests.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View contract amendments (`contract_amendment:read`) | Manage contract amendments (`contract_amendment:write`) |\n" }, "response": [ { "id": "f81e67b5-e05c-438a-b4a5-585686fb59c3", "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/contract-amendments?employment_id=&status=canceled&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Contract Amendment status", "key": "status", "value": "canceled" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"contract_amendments\": [\n {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"status\": \"in_review\",\n \"requested_by\": \"\",\n \"submitted_at\": \"\",\n \"requested_effective_date\": \"\",\n \"reason_for_change\": \"annual_pay_adjustment\",\n \"job_title\": \"\"\n },\n {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"status\": \"canceled\",\n \"requested_by\": \"\",\n \"submitted_at\": \"\",\n \"requested_effective_date\": \"\",\n \"reason_for_change\": \"error_correction\",\n \"job_title\": \"\"\n }\n ],\n \"current_page\": \"\",\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-f81e67b5-e05c-438a-b4a5-585686fb59c3" }, { "id": "49eb8f66-674a-41cd-bb31-8cbcc350dabd", "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/contract-amendments?employment_id=&status=canceled&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Contract Amendment status", "key": "status", "value": "canceled" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-49eb8f66-674a-41cd-bb31-8cbcc350dabd" }, { "id": "c426e71d-1a9c-41d3-986a-f9635899a487", "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/contract-amendments?employment_id=&status=canceled&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Contract Amendment status", "key": "status", "value": "canceled" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-c426e71d-1a9c-41d3-986a-f9635899a487" }, { "id": "ca4a7b50-bde6-4d50-a528-504520ae0ac2", "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/contract-amendments?employment_id=&status=canceled&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Contract Amendment status", "key": "status", "value": "canceled" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-ca4a7b50-bde6-4d50-a528-504520ae0ac2" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-3272f58c-1f0c-4010-98cf-6f2277c30d4a" }, { "name": "Create Contract Amendment", "id": "2bd74ea8-ec6e-4c24-9cc4-4bad7dfd21d6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Creates a Contract Amendment request.\n\nThis endpoint requires and returns country-specific data. The exact required and returned fields will\nvary depending on which country the employment is in. To see the list of parameters for each country,\nsee the **Show form schema** endpoint under the [Contract Amendments](#tag/Contract-Amendments) category.\n\nPlease note that the compliance requirements for each country are subject to change according to local\nlaws. Given its continual updates, using Remote's [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) should be considered in order to avoid\ncompliance issues and to have the latest version of a country requirements.\n\nIf you are using this endpoint to build an integration, make sure you are dynamically collecting or\ndisplaying the latest parameters for each country by querying the _\"Show form schema\"_ endpoint.\n\nFor more information on JSON Schemas, see the **How JSON Schemas work** documentation.\n\nTo learn how you can dynamically generate forms to display in your UI, see the documentation for\nthe [json-schema-form](https://developer.remote.com/docs/how-json-schemas-work) tool.\n\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) |\n" }, "response": [ { "id": "46e74904-d5d3-4a51-b1d7-161175c1a87a", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"contract_amendment\": {\n \"id\": \"\",\n \"amendment_contract_id\": \"\",\n \"employment_id\": \"\",\n \"status\": \"submitted\",\n \"requested_by\": \"\",\n \"submitted_at\": \"\",\n \"request_details\": {\n \"additional_comments\": \"\",\n \"effective_date\": \"\",\n \"reason_for_change\": \"error_correction\",\n \"reason_for_change_description\": \"\",\n \"salary_decrease_details\": {\n \"salary_decrease_reason\": \"change_in_working_hours\",\n \"salary_decrease_reason_description\": \"\",\n \"was_employee_informed\": \"\"\n }\n },\n \"changes\": {},\n \"zendesk_ticket_url\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-46e74904-d5d3-4a51-b1d7-161175c1a87a" }, { "id": "a5af56cc-b808-4f6f-9bd0-8ece2aa341fc", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-a5af56cc-b808-4f6f-9bd0-8ece2aa341fc" }, { "id": "d4d75151-0621-4649-bb89-597be75c10cd", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-d4d75151-0621-4649-bb89-597be75c10cd" }, { "id": "39f84129-c0eb-4341-b6ad-328581105351", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"contract_amendment\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/contract-amendments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contract-amendments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-39f84129-c0eb-4341-b6ad-328581105351" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-2bd74ea8-ec6e-4c24-9cc4-4bad7dfd21d6" } ], "id": "9574c9d5-7f84-4924-8562-6364652c39ab", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-9574c9d5-7f84-4924-8562-6364652c39ab" }, { "name": "probation-completion-letter", "item": [ { "name": "{id}", "item": [ { "name": "Show probation completion letter", "id": "2c5d3195-979d-441f-a9b5-fa65894e6dc5", "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/probation-completion-letter/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter", ":id" ], "variable": [ { "id": "cfe7b6de-3fe1-48db-9f85-fc1d33ab262f", "key": "id", "value": "", "description": "(Required) probation completion letter ID" } ] }, "description": "Show a single probation completion letter.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) |\n" }, "response": [ { "id": "4bceadec-7c6f-4cfb-b279-520f103ec2c3", "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/probation-completion-letter/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"probation_completion_letter\": {\n \"employment_id\": \"\",\n \"letter\": {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n \"id\": \"\",\n \"status\": \"submitted\",\n \"submitted_at\": \"\",\n \"zendesk_ticket_url\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-4bceadec-7c6f-4cfb-b279-520f103ec2c3" }, { "id": "aca09c22-692b-44ab-8537-00544f55caf5", "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/probation-completion-letter/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-aca09c22-692b-44ab-8537-00544f55caf5" }, { "id": "07c3863c-725a-4d88-8a98-61171e799661", "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/probation-completion-letter/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-07c3863c-725a-4d88-8a98-61171e799661" }, { "id": "1674382e-f7ed-4ffe-a38b-5cf5e89250aa", "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/probation-completion-letter/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-1674382e-f7ed-4ffe-a38b-5cf5e89250aa" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-2c5d3195-979d-441f-a9b5-fa65894e6dc5" } ], "id": "3b68e010-e2a5-4903-9c0a-ee2870f3faed", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-3b68e010-e2a5-4903-9c0a-ee2870f3faed" }, { "name": "Create probation completion letter", "id": "1c969f23-c44f-44e0-97b5-84f7954f4bd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-completion-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter" ] }, "description": "Create a new probation completion letter request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) |\n" }, "response": [ { "id": "2f226b9c-fa2c-43f7-bf47-2db54ae1900d", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-completion-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"probation_completion_letter\": {\n \"employment_id\": \"\",\n \"letter\": {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n \"id\": \"\",\n \"status\": \"submitted\",\n \"submitted_at\": \"\",\n \"zendesk_ticket_url\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-2f226b9c-fa2c-43f7-bf47-2db54ae1900d" }, { "id": "2eb6bd12-02cd-467b-8e4c-46938bc156ff", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-completion-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter" ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-2eb6bd12-02cd-467b-8e4c-46938bc156ff" }, { "id": "211d622e-33da-48f1-9139-a28b1110fa7e", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-completion-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter" ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-211d622e-33da-48f1-9139-a28b1110fa7e" }, { "id": "8d29d328-3a26-46b5-bab9-2d8d179e0c7c", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-completion-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-completion-letter" ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-8d29d328-3a26-46b5-bab9-2d8d179e0c7c" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-1c969f23-c44f-44e0-97b5-84f7954f4bd5" } ], "id": "99b8e9d4-f50e-4d7e-9a8e-ccbe5ab37f20", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-99b8e9d4-f50e-4d7e-9a8e-ccbe5ab37f20" }, { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "contract-documents", "item": [ { "name": "List contract documents for an employment", "id": "5d9b364b-0697-4de7-8497-b9186b9dfccd", "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/contract-documents?statuses=finished&statuses=draft&except_statuses=finished&except_statuses=draft&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-documents" ], "query": [ { "description": "Filter by contract document statuses", "key": "statuses", "value": "finished" }, { "description": "Filter by contract document statuses", "key": "statuses", "value": "draft" }, { "description": "Exclude contract documents with specific statuses", "key": "except_statuses", "value": "finished" }, { "description": "Exclude contract documents with specific statuses", "key": "except_statuses", "value": "draft" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "643835d0-dd4d-4632-a46c-1208ba85968b", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Only contractor employment types are supported. Lists contract documents for a specific employment with pagination, filtering by status, and sorted by updated_at descending (latest first).\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": "0b34f40d-18f4-4e29-9ba6-b01485699563", "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/contract-documents?statuses=draft&except_statuses=draft&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-documents" ], "query": [ { "description": "Filter by contract document statuses", "key": "statuses", "value": "draft" }, { "description": "Exclude contract documents with specific statuses", "key": "except_statuses", "value": "draft" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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 \"contract_documents\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"finished\",\n \"type\": \"\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"signatories\": [\n {\n \"type\": \"admin\",\n \"status\": \"pending\",\n \"email\": \"\",\n \"name\": \"\",\n \"signature_method\": \"in_platform\",\n \"signature_type\": \"aes\",\n \"signed_at\": \"\",\n \"user_id\": \"\"\n },\n {\n \"type\": \"company\",\n \"status\": \"pending\",\n \"email\": \"\",\n \"name\": \"\",\n \"signature_method\": \"docusign\",\n \"signature_type\": \"standard\",\n \"signed_at\": \"\",\n \"user_id\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"awaiting_signatures\",\n \"type\": \"\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"signatories\": [\n {\n \"type\": \"company\",\n \"status\": \"unassigned\",\n \"email\": \"\",\n \"name\": \"\",\n \"signature_method\": \"docusign\",\n \"signature_type\": \"qes\",\n \"signed_at\": \"\",\n \"user_id\": \"\"\n },\n {\n \"type\": \"unknown\",\n \"status\": \"signed\",\n \"email\": \"\",\n \"name\": \"\",\n \"signature_method\": \"in_platform\",\n \"signature_type\": \"standard\",\n \"signed_at\": \"\",\n \"user_id\": \"\"\n }\n ]\n }\n ],\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-0b34f40d-18f4-4e29-9ba6-b01485699563" }, { "id": "76418dc4-fef5-4f95-9d1e-d2bf01b5377d", "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/contract-documents?statuses=draft&except_statuses=draft&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-documents" ], "query": [ { "description": "Filter by contract document statuses", "key": "statuses", "value": "draft" }, { "description": "Exclude contract documents with specific statuses", "key": "except_statuses", "value": "draft" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-76418dc4-fef5-4f95-9d1e-d2bf01b5377d" }, { "id": "ead1664b-2cf5-434e-8ff5-514d307f30c3", "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/contract-documents?statuses=draft&except_statuses=draft&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-documents" ], "query": [ { "description": "Filter by contract document statuses", "key": "statuses", "value": "draft" }, { "description": "Exclude contract documents with specific statuses", "key": "except_statuses", "value": "draft" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-ead1664b-2cf5-434e-8ff5-514d307f30c3" }, { "id": "0921131c-6f14-4c69-8205-d96aebb4d8c8", "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/contract-documents?statuses=draft&except_statuses=draft&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-documents" ], "query": [ { "description": "Filter by contract document statuses", "key": "statuses", "value": "draft" }, { "description": "Exclude contract documents with specific statuses", "key": "except_statuses", "value": "draft" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-0921131c-6f14-4c69-8205-d96aebb4d8c8" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-5d9b364b-0697-4de7-8497-b9186b9dfccd" } ], "id": "ce19fd03-83b0-413c-b31a-61664842d1ec", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-ce19fd03-83b0-413c-b31a-61664842d1ec" }, { "name": "employment-agreement", "item": [ { "name": "download", "item": [ { "name": "Download the Employment Agreement for an employment", "id": "216cb678-2981-4f8d-8fb1-0d0e9994e934", "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": "9c0c4955-7648-4e3b-b805-20f78021cdd0", "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": "43f79058-ad28-4a84-8767-1f0166c86c53", "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-43f79058-ad28-4a84-8767-1f0166c86c53" }, { "id": "bae7001e-4acd-4ce3-88c2-eca1e316ee74", "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-bae7001e-4acd-4ce3-88c2-eca1e316ee74" }, { "id": "e3259858-b24a-4986-ac50-7934c95f4783", "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-e3259858-b24a-4986-ac50-7934c95f4783" }, { "id": "f8e3d782-e168-4620-a756-1471c3d6455c", "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-f8e3d782-e168-4620-a756-1471c3d6455c" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-216cb678-2981-4f8d-8fb1-0d0e9994e934" } ], "id": "78b6a722-e414-456f-935e-cdf7da7fbb08", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-78b6a722-e414-456f-935e-cdf7da7fbb08" }, { "name": "preview", "item": [ { "name": "Preview the Employment Agreement for an employment", "id": "ef779330-3dc5-4ab0-ae2c-c85b9ea31070", "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": "7907c73b-ef06-4d31-b85e-082a455e1c45", "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": "f2d7fb1c-734e-4746-a7ac-11decb8e5fa0", "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-f2d7fb1c-734e-4746-a7ac-11decb8e5fa0" }, { "id": "3f784aff-3dce-467f-a95b-1a88f984d515", "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-3f784aff-3dce-467f-a95b-1a88f984d515" }, { "id": "35698cf8-c7ed-443f-b993-3330435b8f37", "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-35698cf8-c7ed-443f-b993-3330435b8f37" }, { "id": "64ecf264-5cfe-4a2f-8a58-d2ee6681b37c", "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-64ecf264-5cfe-4a2f-8a58-d2ee6681b37c" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-ef779330-3dc5-4ab0-ae2c-c85b9ea31070" } ], "id": "9d56b9d2-97f8-4c91-b560-79af7ade861d", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-9d56b9d2-97f8-4c91-b560-79af7ade861d" } ], "id": "7929a415-b481-41da-8c97-731c97a3d8ef", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-7929a415-b481-41da-8c97-731c97a3d8ef" }, { "name": "contract-eligibility", "item": [ { "name": "Create contract eligibility", "id": "83972632-d308-4c05-aebc-1b36e205505a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"eligible_to_work_in_residing_country\": \"temporary_resident\",\n \"employer_or_work_restrictions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-eligibility" ], "variable": [ { "id": "37411c7a-fef2-4c91-8d06-e1f1f62e7e6b", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Create contract eligibility for an employment.\n\nThis will create a new contract eligibility for the employment.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage contract eligibility (`contract_eligibility:write`) |\n" }, "response": [ { "id": "8a80bab8-88ac-4483-8ad0-a0ea86f9589f", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"eligible_to_work_in_residing_country\": \"temporary_resident\",\n \"employer_or_work_restrictions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-eligibility" ], "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 \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-8a80bab8-88ac-4483-8ad0-a0ea86f9589f" }, { "id": "33eae567-4648-4374-9efd-8869ff735bb5", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"eligible_to_work_in_residing_country\": \"temporary_resident\",\n \"employer_or_work_restrictions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-eligibility" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-33eae567-4648-4374-9efd-8869ff735bb5" }, { "id": "6e9c372f-d898-4a64-ad18-fbb7e1777f41", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"eligible_to_work_in_residing_country\": \"temporary_resident\",\n \"employer_or_work_restrictions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-eligibility" ], "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-6e9c372f-d898-4a64-ad18-fbb7e1777f41" }, { "id": "40b0f06a-7aa0-413a-a9a9-116b2851b686", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"eligible_to_work_in_residing_country\": \"temporary_resident\",\n \"employer_or_work_restrictions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-eligibility" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-40b0f06a-7aa0-413a-a9a9-116b2851b686" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-83972632-d308-4c05-aebc-1b36e205505a" } ], "id": "fcb4927d-6b7c-4605-bcc2-d04d573dd7c2", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-fcb4927d-6b7c-4605-bcc2-d04d573dd7c2" } ], "id": "a2d5f0b5-a493-464c-94d8-3aabec05e75d", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-a2d5f0b5-a493-464c-94d8-3aabec05e75d" } ], "id": "44b7bedf-1c7f-4b2e-b391-a02094220d06", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-44b7bedf-1c7f-4b2e-b391-a02094220d06" }, { "name": "probation-extensions", "item": [ { "name": "{id}", "item": [ { "name": "Show Probation Extension", "id": "852fde0b-cd05-472c-847c-0a9b2ca72bdb", "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/probation-extensions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions", ":id" ], "variable": [ { "id": "c60e7cea-c154-4d0b-9e00-b16f195c466e", "key": "id", "value": "", "description": "(Required) Probation Extension Request ID" } ] }, "description": "Shows a Probation Extension Request.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View probation documents (`probation_document:read`) | Manage probation documents (`probation_document:write`) |\n" }, "response": [ { "id": "58d2d534-b8e1-4dc7-ba0c-3c7febe2784e", "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/probation-extensions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"probation_extension\": {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"status\": \"done\",\n \"submitted_at\": \"\",\n \"requested_by\": \"\",\n \"zendesk_ticket_url\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-58d2d534-b8e1-4dc7-ba0c-3c7febe2784e" }, { "id": "a49bc48e-8ecd-48b9-a07d-ff5ab35bf024", "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/probation-extensions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-a49bc48e-8ecd-48b9-a07d-ff5ab35bf024" }, { "id": "713928f8-a199-433c-9acb-26bc814ddcf2", "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/probation-extensions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-713928f8-a199-433c-9acb-26bc814ddcf2" }, { "id": "d63d40c8-aff4-4956-a3af-4f7cd549b171", "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/probation-extensions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions", ":id" ], "variable": [ { "key": "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-d63d40c8-aff4-4956-a3af-4f7cd549b171" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-852fde0b-cd05-472c-847c-0a9b2ca72bdb" } ], "id": "f32c9750-ba47-4784-97fe-09c0480f3e60", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-f32c9750-ba47-4784-97fe-09c0480f3e60" }, { "name": "Create Probation Extension", "id": "99471b3e-493e-4333-983d-7c4005a76838", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"duration_of_extension_in_days\": \"\",\n \"reason_for_extension\": \"\",\n \"was_employee_informed\": \"\",\n \"additional_details\": \"\",\n \"date_of_discussion_with_employee\": \"\",\n \"supporting_document\": {\n \"name\": \"\",\n \"content\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-extensions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions" ] }, "description": "Create a probation extension request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage probation documents (`probation_document:write`) |\n" }, "response": [ { "id": "730eaf5e-a913-4721-8579-04d5e1a2b15d", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"duration_of_extension_in_days\": \"\",\n \"reason_for_extension\": \"\",\n \"was_employee_informed\": \"\",\n \"additional_details\": \"\",\n \"date_of_discussion_with_employee\": \"\",\n \"supporting_document\": {\n \"name\": \"\",\n \"content\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-extensions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"probation_extension\": {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"status\": \"done\",\n \"submitted_at\": \"\",\n \"requested_by\": \"\",\n \"zendesk_ticket_url\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-730eaf5e-a913-4721-8579-04d5e1a2b15d" }, { "id": "70ebb177-f239-42e7-b259-db9cec4328c1", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"duration_of_extension_in_days\": \"\",\n \"reason_for_extension\": \"\",\n \"was_employee_informed\": \"\",\n \"additional_details\": \"\",\n \"date_of_discussion_with_employee\": \"\",\n \"supporting_document\": {\n \"name\": \"\",\n \"content\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-extensions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-70ebb177-f239-42e7-b259-db9cec4328c1" }, { "id": "af4e1215-3ff6-49b7-ab0b-3cb933c3a8b6", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"duration_of_extension_in_days\": \"\",\n \"reason_for_extension\": \"\",\n \"was_employee_informed\": \"\",\n \"additional_details\": \"\",\n \"date_of_discussion_with_employee\": \"\",\n \"supporting_document\": {\n \"name\": \"\",\n \"content\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-extensions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions" ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-af4e1215-3ff6-49b7-ab0b-3cb933c3a8b6" }, { "id": "163e9016-63ba-4848-a3fd-36a01d5511b1", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"duration_of_extension_in_days\": \"\",\n \"reason_for_extension\": \"\",\n \"was_employee_informed\": \"\",\n \"additional_details\": \"\",\n \"date_of_discussion_with_employee\": \"\",\n \"supporting_document\": {\n \"name\": \"\",\n \"content\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-extensions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions" ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-163e9016-63ba-4848-a3fd-36a01d5511b1" }, { "id": "b597413e-cb4a-4206-af1a-3923b63ca715", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\",\n \"duration_of_extension_in_days\": \"\",\n \"reason_for_extension\": \"\",\n \"was_employee_informed\": \"\",\n \"additional_details\": \"\",\n \"date_of_discussion_with_employee\": \"\",\n \"supporting_document\": {\n \"name\": \"\",\n \"content\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/probation-extensions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "probation-extensions" ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-b597413e-cb4a-4206-af1a-3923b63ca715" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-99471b3e-493e-4333-983d-7c4005a76838" } ], "id": "a2828f4a-056f-4d02-ad8f-8026113a3849", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-a2828f4a-056f-4d02-ad8f-8026113a3849" }, { "name": "employment-contracts", "item": [ { "name": "{employment_id}", "item": [ { "name": "pending-changes", "item": [ { "name": "Get employment contract pending changes", "id": "6fb6331f-6bf5-4a2f-9248-f8818f8a827b", "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/employment-contracts/:employment_id/pending-changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts", ":employment_id", "pending-changes" ], "variable": [ { "id": "1dc5b150-5f7b-4a0f-bba3-96022a3acb4a", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Get all the pending changes (waiting for aproval or signature) for the employment contract.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View contracts (`contract:read`) | - |\n" }, "response": [ { "id": "1c544ed7-5f6b-4d86-b2c3-0f58a5d84aed", "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/employment-contracts/:employment_id/pending-changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts", ":employment_id", "pending-changes" ], "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 \"pending_changes\": [\n {\n \"effective_at\": \"\",\n \"contract_id\": \"\",\n \"changes\": {},\n \"pending_action_for_activation\": \"\"\n },\n {\n \"effective_at\": \"\",\n \"contract_id\": \"\",\n \"changes\": {},\n \"pending_action_for_activation\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-1c544ed7-5f6b-4d86-b2c3-0f58a5d84aed" }, { "id": "3873383d-580a-4398-a803-9df9bb0f39bf", "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/employment-contracts/:employment_id/pending-changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts", ":employment_id", "pending-changes" ], "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-3873383d-580a-4398-a803-9df9bb0f39bf" }, { "id": "3c0782a9-4e03-44e6-bf61-fa5e98b3b0bb", "name": "Forbidden", "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/employment-contracts/:employment_id/pending-changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts", ":employment_id", "pending-changes" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-3c0782a9-4e03-44e6-bf61-fa5e98b3b0bb" }, { "id": "e40bb31a-6caf-44f3-9a24-410352e0bc27", "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/employment-contracts/:employment_id/pending-changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts", ":employment_id", "pending-changes" ], "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-e40bb31a-6caf-44f3-9a24-410352e0bc27" }, { "id": "ef4711df-a11e-47a8-9d33-94457b3dfa2c", "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/employment-contracts/:employment_id/pending-changes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts", ":employment_id", "pending-changes" ], "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-ef4711df-a11e-47a8-9d33-94457b3dfa2c" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-6fb6331f-6bf5-4a2f-9248-f8818f8a827b" } ], "id": "44bff53e-4fd2-48c5-bda5-6f2640a8cc1b", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-44bff53e-4fd2-48c5-bda5-6f2640a8cc1b" } ], "id": "e601b488-6d21-49b5-b1c3-8cfa51ad2441", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-e601b488-6d21-49b5-b1c3-8cfa51ad2441" }, { "name": "List Employment Contract.", "id": "de7303df-1586-4ec4-9796-42ad58dbb07e", "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/employment-contracts?employment_id=&only_active=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts" ], "query": [ { "description": "(Required) Employment ID", "key": "employment_id", "value": "" }, { "description": "Only Active", "key": "only_active", "value": "" } ] }, "description": "Get the employment contract history for a given employment. If `only_active` is true, it will return only the active or last active contract.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View contracts (`contract:read`) | - |\n" }, "response": [ { "id": "8b41a348-f530-451e-8b92-856920b09e6b", "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/employment-contracts?employment_id=&only_active=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts" ], "query": [ { "description": "(Required) Employment ID", "key": "employment_id", "value": "" }, { "description": "Only Active", "key": "only_active", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment_contracts\": [\n {\n \"contract_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"contract_details\": {},\n \"compensation\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"wage_type\": \"salary\"\n },\n \"job_title\": \"\",\n \"status\": \"pending\",\n \"activated_at\": \"\",\n \"effective_at\": \"\"\n },\n {\n \"contract_id\": \"\",\n \"amendment_contract_id\": \"\",\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"contract_details\": {},\n \"compensation\": {\n \"amount\": \"\",\n \"currency_code\": \"\",\n \"wage_type\": \"hourly\"\n },\n \"job_title\": \"\",\n \"status\": \"pending\",\n \"activated_at\": \"\",\n \"effective_at\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-8b41a348-f530-451e-8b92-856920b09e6b" }, { "id": "d2448d82-bd47-4928-a43f-9390c918fab2", "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/employment-contracts?employment_id=&only_active=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts" ], "query": [ { "description": "(Required) Employment ID", "key": "employment_id", "value": "" }, { "description": "Only Active", "key": "only_active", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-d2448d82-bd47-4928-a43f-9390c918fab2" }, { "id": "6f57cea2-3871-4f36-8648-8da30262f72e", "name": "Forbidden", "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/employment-contracts?employment_id=&only_active=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts" ], "query": [ { "description": "(Required) Employment ID", "key": "employment_id", "value": "" }, { "description": "Only Active", "key": "only_active", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-6f57cea2-3871-4f36-8648-8da30262f72e" }, { "id": "ac3725a2-0156-4f93-aac8-0a7848bc83a5", "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/employment-contracts?employment_id=&only_active=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts" ], "query": [ { "description": "(Required) Employment ID", "key": "employment_id", "value": "" }, { "description": "Only Active", "key": "only_active", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-ac3725a2-0156-4f93-aac8-0a7848bc83a5" }, { "id": "af0694f7-4943-477d-9375-7dcfc2933b2d", "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/employment-contracts?employment_id=&only_active=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employment-contracts" ], "query": [ { "description": "(Required) Employment ID", "key": "employment_id", "value": "" }, { "description": "Only Active", "key": "only_active", "value": "" } ] } }, "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:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-af0694f7-4943-477d-9375-7dcfc2933b2d" } ], "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-de7303df-1586-4ec4-9796-42ad58dbb07e" } ], "id": "6dd0f2ef-8e5a-413c-8928-116ed156e36c", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-6dd0f2ef-8e5a-413c-8928-116ed156e36c" } ], "id": "28939f34-ddf2-42a7-a2bf-4280533e604d", "createdAt": "2026-07-28T02:45:18.000Z", "updatedAt": "2026-07-28T02:45:18.000Z", "uid": "35240-28939f34-ddf2-42a7-a2bf-4280533e604d" } ], "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/" } ] }