{ "info": { "_postman_id": "bb963197-0f3b-483e-877c-b9013adf5ab6", "name": "Remote Address Details Employment Management API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "lastUpdatedBy": "35240", "uid": "35240-bb963197-0f3b-483e-877c-b9013adf5ab6" }, "item": [ { "name": "v1", "item": [ { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "contract-origin", "item": [ { "name": "Set contract origin for a contractor employment", "id": "18932d71-2b7e-409f-b6fa-1a356759fa0d", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "variable": [ { "id": "1f2e5935-00fa-4c9c-b273-8fb6f041f579", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Sets the `contract_origin` for a contractor employment.\n\n* `remote_contract` \u2014 Remote provides and manages the contract (a contract document is created)\n* `custom_remote_contract` \u2014 A customised Remote contract is used (a contract document is created)\n* `provided_by_customer` \u2014 The employer provides their own contract (no contract document is created)\n\nWhen `provided_by_customer` is selected, the contractor can be invited without completing the\n`contract_details` onboarding step.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "2bdc1195-103b-4a41-84df-da3dd66465ad", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-2bdc1195-103b-4a41-84df-da3dd66465ad" }, { "id": "52904019-25cd-4045-9f97-702cd0577e43", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-52904019-25cd-4045-9f97-702cd0577e43" }, { "id": "906a0cdb-21eb-4875-ac78-541c16fc6a2c", "name": "Conflict", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-906a0cdb-21eb-4875-ac78-541c16fc6a2c" }, { "id": "c3bc3e41-33c1-43b9-b123-12235e61d743", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-c3bc3e41-33c1-43b9-b123-12235e61d743" }, { "id": "9077c4b6-855e-429d-adc6-2eb16f92193c", "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 \"contract_origin\": \"remote_contract\",\n \"template_type\": \"custom_contractor_agreement\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/contract-origin", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "contract-origin" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-9077c4b6-855e-429d-adc6-2eb16f92193c" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-18932d71-2b7e-409f-b6fa-1a356759fa0d" } ], "id": "46a48567-b0f8-4008-b027-f23d26730bc2", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-46a48567-b0f8-4008-b027-f23d26730bc2" }, { "name": "invite", "item": [ { "name": "Invite employment", "id": "42f8b652-fede-4c9f-8aa0-166c347dba57", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "variable": [ { "id": "d5b47caa-c9b7-43d9-a181-3cb27fecc692", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Invite an employment to start the self-enrollment.\n\nRequirements for the invitation to succeed:\n\n* Employment needs to have the following JSON Schema forms filled: `contract_details` and `pricing_plan_details`\n* `provisional_start_date` must consider the minimum onboarding time of the employment's country\n\nIf there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message.\nHTTP Status OK (200) is returned in case of success.\n\nIn case of the following error message:\n`\"Please reselect benefits - the previous selection is no longer available\"`\nit means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema.\n\nIn this case, reselect benefits by updating `contract_details` JSON Schema form.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "d5013123-2754-40e0-ac3b-5c4531040943", "name": "Success", "originalRequest": { "method": "POST", "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/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-d5013123-2754-40e0-ac3b-5c4531040943" }, { "id": "9568a205-6fcf-48ac-95ef-e0dbd88961e8", "name": "Bad Request", "originalRequest": { "method": "POST", "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/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-9568a205-6fcf-48ac-95ef-e0dbd88961e8" }, { "id": "cdd9c9c1-db67-45df-a9cc-fde52a726ad6", "name": "Conflict", "originalRequest": { "method": "POST", "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/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-cdd9c9c1-db67-45df-a9cc-fde52a726ad6" }, { "id": "754f5756-edb7-4bf8-9859-6fbab4bf200e", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "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/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-754f5756-edb7-4bf8-9859-6fbab4bf200e" }, { "id": "8e9ba683-d931-4426-b2c6-04d02b6813d7", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "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/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "invite" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-8e9ba683-d931-4426-b2c6-04d02b6813d7" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-42f8b652-fede-4c9f-8aa0-166c347dba57" } ], "id": "271f2cc5-952f-4caa-bc35-2d26f2305c26", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-271f2cc5-952f-4caa-bc35-2d26f2305c26" }, { "name": "Show employment", "id": "19636cb0-04dd-4fed-912d-2d71b756547b", "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?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "variable": [ { "id": "a9cb844d-6e6e-49ec-91cb-113da151ad9c", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Shows all the information of an employment.\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 [Countries](#tag/Countries) 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`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "4f95b44b-5248-4c3c-b1f7-6156a0e9c3be", "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?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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\": {\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": [],\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"standard\"\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 \"created_at\": \"\",\n \"emergency_contact_details\": {},\n \"files\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"full_name\": \"\",\n \"id\": \"\",\n \"type\": \"global_payroll_employee\",\n \"employment_model\": \"global_payroll\",\n \"work_address_details\": {},\n \"job_title\": \"\",\n \"manager_email\": \"\",\n \"manager_employment_id\": \"\",\n \"onboarding_tasks\": {\n \"address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"review\",\n \"employment_lifecycle_stage\": \"right_to_work_check\",\n \"updated_at\": \"\",\n \"work_email\": \"\",\n \"eligible_for_onboarding_cancellation\": \"\",\n \"short_id\": \"\",\n \"department\": \"\",\n \"provisional_start_date\": \"\",\n \"contractor_settings\": {\n \"requires_work_confirmation\": \"\"\n },\n \"contractor_type\": \"standard\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"hourly\"\n },\n \"expiration_date\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"basic_information\": {},\n \"probation_period_end_date\": \"\",\n \"department_id\": \"\",\n \"manager\": \"\",\n \"external_id\": \"\",\n \"user_status\": \"cancelled\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"termination_date\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-4f95b44b-5248-4c3c-b1f7-6156a0e9c3be" }, { "id": "5239afd3-4453-456b-ae4f-17271c09deb1", "name": "Bad Request", "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?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-5239afd3-4453-456b-ae4f-17271c09deb1" }, { "id": "13238016-fe8c-41d3-af3b-bff6ee0dd566", "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/employments/:employment_id?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-13238016-fe8c-41d3-af3b-bff6ee0dd566" }, { "id": "57645808-1adc-404f-b709-fa375a402bd6", "name": "Conflict", "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?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-57645808-1adc-404f-b709-fa375a402bd6" }, { "id": "5373b91c-2fbb-4957-95d6-da7013281c48", "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?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-5373b91c-2fbb-4957-95d6-da7013281c48" }, { "id": "d764977d-a815-4545-9f3e-3c11dbb63e39", "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?exclude_files=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Wether files should be excluded", "key": "exclude_files", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-d764977d-a815-4545-9f3e-3c11dbb63e39" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-19636cb0-04dd-4fed-912d-2d71b756547b" }, { "name": "Update employment", "id": "b5a8142b-6d72-4b11-bf41-35969ac805bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "variable": [ { "id": "af04e574-e499-4367-bc17-d987ce9466d8", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates an employment.\n\n**For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information.\n\n**For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email.\n\n**For `invited` employments:** You can update the work_email.\n\nAfter onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`.\nIf you want to provide additional information for an employment, please make sure to do so **before** the employee is invited.\nWe block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details.\nCurrently, these amendments can only be done through the Remote UI.\n\nIt is possible to update the `external_id` of the employment for all employment statuses.\n\n## Global Payroll Employees\n\nTo update a Global Payment employment your input data must comply with the global payroll json schemas.\n\n**For `active` employments:** In addition to the above list, you can update personal_details.\n\n## Direct Employees\n\nTo update an HRIS employment your input data must comply with the HRIS json schemas.\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 [Countries](#tag/Countries) 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\nPlease contact Remote if you need to update contractors via API since it's currently not supported.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "d37c1899-9fb8-44eb-9aca-1f62151590d8", "name": "Success", "originalRequest": { "method": "PATCH", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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\": {\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": [],\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"cor\"\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 \"created_at\": \"\",\n \"emergency_contact_details\": {},\n \"files\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"full_name\": \"\",\n \"id\": \"\",\n \"type\": \"global_payroll_employee\",\n \"employment_model\": \"peo\",\n \"work_address_details\": {},\n \"job_title\": \"\",\n \"manager_email\": \"\",\n \"manager_employment_id\": \"\",\n \"onboarding_tasks\": {\n \"address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"active\",\n \"employment_lifecycle_stage\": \"contract_signing\",\n \"updated_at\": \"\",\n \"work_email\": \"\",\n \"eligible_for_onboarding_cancellation\": \"\",\n \"short_id\": \"\",\n \"department\": \"\",\n \"provisional_start_date\": \"\",\n \"contractor_settings\": {\n \"requires_work_confirmation\": \"\"\n },\n \"contractor_type\": \"standard\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\n },\n \"expiration_date\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"basic_information\": {},\n \"probation_period_end_date\": \"\",\n \"department_id\": \"\",\n \"manager\": \"\",\n \"external_id\": \"\",\n \"user_status\": \"active\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-d37c1899-9fb8-44eb-9aca-1f62151590d8" }, { "id": "be44dc79-fa40-46e9-aa0c-304e5c3c26ce", "name": "Bad Request", "originalRequest": { "method": "PATCH", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-be44dc79-fa40-46e9-aa0c-304e5c3c26ce" }, { "id": "a40c0634-01d4-4262-ae3c-52c9fd5f3ef6", "name": "Forbidden", "originalRequest": { "method": "PATCH", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-a40c0634-01d4-4262-ae3c-52c9fd5f3ef6" }, { "id": "4233e13b-bbc1-475b-bbb5-42a50f8215ae", "name": "Conflict", "originalRequest": { "method": "PATCH", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-4233e13b-bbc1-475b-bbb5-42a50f8215ae" }, { "id": "ddb7110c-59d4-4649-b28f-8affb48aa0a6", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-ddb7110c-59d4-4649-b28f-8affb48aa0a6" }, { "id": "c7b15447-8962-4270-8481-8bb883a6ba78", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-c7b15447-8962-4270-8481-8bb883a6ba78" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-b5a8142b-6d72-4b11-bf41-35969ac805bc" }, { "name": "Update employment", "id": "164f4cc5-ce9c-466d-9ada-e430c3eb8a9a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "variable": [ { "id": "f7f0ff5f-5cf7-461f-b533-fbf668dae5a8", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Updates an employment.\n\n**For `created` employments:** You can change all basic params and onboarding tasks or perform a per onboarding task update. You can also update basic_information.\n\n**For `active` employments:** You can update the manager (`manager_id` field), emergency_contact_details, address_details and work_email.\n\n**For `invited` employments:** You can update the work_email.\n\nAfter onboarding, only a limited set of employment data will be available for updates, such as `emergency_contact_details`.\nIf you want to provide additional information for an employment, please make sure to do so **before** the employee is invited.\nWe block updates to some employment data because employees need to agree to amendments in certain cases, such as when there are changes to their contract_details.\nCurrently, these amendments can only be done through the Remote UI.\n\nIt is possible to update the `external_id` of the employment for all employment statuses.\n\n## Global Payroll Employees\n\nTo update a Global Payment employment your input data must comply with the global payroll json schemas.\n\n**For `active` employments:** In addition to the above list, you can update personal_details.\n\n## Direct Employees\n\nTo update an HRIS employment your input data must comply with the HRIS json schemas.\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 [Countries](#tag/Countries) 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\nPlease contact Remote if you need to update contractors via API since it's currently not supported.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "25519030-0d5d-482a-9d60-651ce4d818d9", "name": "Success", "originalRequest": { "method": "PUT", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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\": {\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": [],\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"cor\"\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 \"created_at\": \"\",\n \"emergency_contact_details\": {},\n \"files\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"full_name\": \"\",\n \"id\": \"\",\n \"type\": \"global_payroll_employee\",\n \"employment_model\": \"peo\",\n \"work_address_details\": {},\n \"job_title\": \"\",\n \"manager_email\": \"\",\n \"manager_employment_id\": \"\",\n \"onboarding_tasks\": {\n \"address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"active\",\n \"employment_lifecycle_stage\": \"contract_signing\",\n \"updated_at\": \"\",\n \"work_email\": \"\",\n \"eligible_for_onboarding_cancellation\": \"\",\n \"short_id\": \"\",\n \"department\": \"\",\n \"provisional_start_date\": \"\",\n \"contractor_settings\": {\n \"requires_work_confirmation\": \"\"\n },\n \"contractor_type\": \"standard\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\n },\n \"expiration_date\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"basic_information\": {},\n \"probation_period_end_date\": \"\",\n \"department_id\": \"\",\n \"manager\": \"\",\n \"external_id\": \"\",\n \"user_status\": \"active\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-25519030-0d5d-482a-9d60-651ce4d818d9" }, { "id": "4fa9bce0-d857-41ec-bdd7-5d8a365e8f2c", "name": "Bad Request", "originalRequest": { "method": "PUT", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-4fa9bce0-d857-41ec-bdd7-5d8a365e8f2c" }, { "id": "7d0fe913-298e-488f-8362-ba365d249d9d", "name": "Forbidden", "originalRequest": { "method": "PUT", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-7d0fe913-298e-488f-8362-ba365d249d9d" }, { "id": "b22b385f-eae5-4b21-bd77-1fa9aaab9e30", "name": "Conflict", "originalRequest": { "method": "PUT", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-b22b385f-eae5-4b21-bd77-1fa9aaab9e30" }, { "id": "e87e1550-f265-4ec1-acb7-14ad82e8951c", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-e87e1550-f265-4ec1-acb7-14ad82e8951c" }, { "id": "9f9de33f-c363-4b63-a041-f63dbf9644ea", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "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 \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": {},\n \"basic_information\": {},\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\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 \"country_code\": \"\",\n \"department_id\": \"\",\n \"emergency_contact_details\": {},\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"personal_details\": {},\n \"pricing_plan_details\": {},\n \"type\": \"employee\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id?address_details_json_schema_version=&administrative_details_json_schema_version=&bank_account_details_json_schema_version=&employment_basic_information_json_schema_version=&billing_address_details_json_schema_version=&contract_details_json_schema_version=&emergency_contact_details_json_schema_version=&personal_details_json_schema_version=&pricing_plan_details_json_schema_version=&skip_benefits=&actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the administrative_details form schema", "key": "administrative_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Version of the employment_basic_information form schema", "key": "employment_basic_information_json_schema_version", "value": "" }, { "description": "Version of the billing_address_details form schema", "key": "billing_address_details_json_schema_version", "value": "" }, { "description": "Version of the contract_details form schema", "key": "contract_details_json_schema_version", "value": "" }, { "description": "Version of the emergency_contact_details form schema", "key": "emergency_contact_details_json_schema_version", "value": "" }, { "description": "Version of the personal_details form schema", "key": "personal_details_json_schema_version", "value": "" }, { "description": "Version of the pricing_plan_details form schema", "key": "pricing_plan_details_json_schema_version", "value": "" }, { "description": "Skips the dynamic benefits part of the schema if set. To be used when benefits are set via its own API.", "key": "skip_benefits", "value": "" }, { "description": "Complementary action(s) to perform when creating an employment.", "key": "actions", "value": "" } ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-9f9de33f-c363-4b63-a041-f63dbf9644ea" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-164f4cc5-ce9c-466d-9ada-e430c3eb8a9a" } ], "id": "6a6fba84-7416-4e5c-8aaf-55f115ffb60f", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-6a6fba84-7416-4e5c-8aaf-55f115ffb60f" }, { "name": "List employments", "id": "23e0027a-8657-4a82-8c52-dcc0c036d7e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=peo&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "peo" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "Lists all employments, except for the deleted ones.\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 [Countries](#tag/Countries) 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" }, "response": [ { "id": "1b01a450-c888-447d-bb67-1f398516eeb3", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=peo&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "peo" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "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 \"current_page\": \"\",\n \"employments\": [\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"standard\"\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 \"full_name\": \"\",\n \"id\": \"\",\n \"job_title\": \"\",\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"status\": \"created_reserve_paid\",\n \"type\": \"employee\",\n \"short_id\": \"\",\n \"external_id\": \"\",\n \"employment_lifecycle_stage\": \"employment_creation\",\n \"work_address_details\": {},\n \"employment_model\": \"global_payroll\",\n \"work_email\": \"\",\n \"department\": \"\",\n \"department_id\": \"\"\n },\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\n \"cor\"\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 \"full_name\": \"\",\n \"id\": \"\",\n \"job_title\": \"\",\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"status\": \"invited\",\n \"type\": \"employee\",\n \"short_id\": \"\",\n \"external_id\": \"\",\n \"employment_lifecycle_stage\": \"remote_enrollment\",\n \"work_address_details\": {},\n \"employment_model\": \"global_payroll\",\n \"work_email\": \"\",\n \"department\": \"\",\n \"department_id\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-1b01a450-c888-447d-bb67-1f398516eeb3" }, { "id": "e02cd67c-edbd-41fd-9acd-882526685bb8", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=peo&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "peo" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-e02cd67c-edbd-41fd-9acd-882526685bb8" }, { "id": "c93cb563-c30a-4698-95cc-28d6fa8dbcc2", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=peo&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "peo" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-c93cb563-c30a-4698-95cc-28d6fa8dbcc2" }, { "id": "8a338ae6-e274-419f-893f-c3b4547d2569", "name": "Conflict", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=peo&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "peo" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-8a338ae6-e274-419f-893f-c3b4547d2569" }, { "id": "721ff350-b8f7-40f5-b909-f5910cfe3bac", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=peo&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "peo" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-721ff350-b8f7-40f5-b909-f5910cfe3bac" }, { "id": "a74879b9-67d7-4871-8612-eb8730ee2072", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employments?company_id=&email=&status=&employment_type=&employment_model=peo&short_id=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Company ID", "key": "company_id", "value": "" }, { "description": "Filters the results by employments whose login email matches the value", "key": "email", "value": "" }, { "description": "Filters the results by employments whose status matches the value.\nSupports multiple values separated by commas.\nAlso supports the value `incomplete` to get all employments that are not onboarded yet.\n", "key": "status", "value": "" }, { "description": "Filters the results by employments whose employment product type matches the value", "key": "employment_type", "value": "" }, { "description": "Filters the results by employments whose employment model matches the value.\nPossible values: `global_payroll`, `peo`, `eor`\n", "key": "employment_model", "value": "peo" }, { "description": "Filters the results by the employment's short ID. Returns at most one result.", "key": "short_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-a74879b9-67d7-4871-8612-eb8730ee2072" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-23e0027a-8657-4a82-8c52-dcc0c036d7e1" }, { "name": "Create employment", "id": "940235cb-dc1e-4557-a60c-12ddcf03bcb0", "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 \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"contractor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Creates an employment. We support creating employees and contractors.\n\n## Global Payroll Employees\n\nTo create a Global Payroll employee, pass `global_payroll_employee` as the `type` parameter,\nand provide the id of the specific legal entity that the employee will be engaged by and billed to as the `engaged_by_legal_entity_id` parameter.\n\n## HRIS Employees\n\nTo create a HRIS employee, pass `hris` as the `type` parameter.\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 [Countries](#tag/Countries) 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 employments (`employment:write`) |\n" }, "response": [ { "id": "d9480cfd-d23b-4c79-bba4-580389da15a5", "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 \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"contractor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "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 \"employment\": {\n \"basic_information\": {},\n \"company_id\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"employment_lifecycle_stage\": \"remote_enrollment\",\n \"full_name\": \"\",\n \"id\": \"\",\n \"job_title\": \"\",\n \"login_email\": \"\",\n \"personal_email\": \"\",\n \"provisional_start_date\": \"\",\n \"type\": \"employee\",\n \"updated_at\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-d9480cfd-d23b-4c79-bba4-580389da15a5" }, { "id": "ff7ae8e9-5e87-403b-98da-72a89aca0752", "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 \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"contractor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-ff7ae8e9-5e87-403b-98da-72a89aca0752" }, { "id": "b0c6053f-ffcb-4169-b2ee-63ab8fa63e14", "name": "Forbidden", "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 \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"contractor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-b0c6053f-ffcb-4169-b2ee-63ab8fa63e14" }, { "id": "3a1aebb9-6f8c-4b43-b350-ba1f5b17d611", "name": "Conflict", "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 \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"contractor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-3a1aebb9-6f8c-4b43-b350-ba1f5b17d611" }, { "id": "1f33f8a7-fc24-42e3-8d76-720a81e3d837", "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 \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"contractor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-1f33f8a7-fc24-42e3-8d76-720a81e3d837" }, { "id": "fec92c9e-4452-4c93-8dd8-39b203ae7d60", "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 \"basic_information\": {},\n \"country_code\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"company_id\": \"\",\n \"engaged_by_entity_slug\": \"\",\n \"engaged_by_legal_entity_id\": \"\",\n \"external_id\": \"\",\n \"type\": \"contractor\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/employments?json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments" ], "query": [ { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-fec92c9e-4452-4c93-8dd8-39b203ae7d60" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-940235cb-dc1e-4557-a60c-12ddcf03bcb0" } ], "id": "7c5ad338-c33e-4a25-bc2d-030c560a5573", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-7c5ad338-c33e-4a25-bc2d-030c560a5573" }, { "name": "bulk-employment-jobs", "item": [ { "name": "{job_id}", "item": [ { "name": "rows", "item": [ { "name": "List bulk employment rows", "id": "e0bc823b-0502-4162-b530-169f2e609fff", "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/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "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": "18d52044-fd0d-4d2b-b3ae-e07033698f07", "key": "job_id", "value": "", "description": "(Required) Bulk employment job id" } ] }, "description": "Returns grouped bulk employment rows, including field-level validation errors in `errors`, row-level failures in `row_errors`, and submission-phase failures in `submission_errors`. If a row passes validation but later fails during Global Payroll activation, that failure is surfaced here after submission rather than in the initial create response.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "9b9e32ca-1404-464a-94f8-6998b2807583", "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/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "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": "job_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"rows\": {\n \"failures\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"uteea\": [\n \"\",\n \"\"\n ],\n \"laborume3\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"veniam_159\": -73138647.81670128,\n \"ad__b\": 34081710.2568682,\n \"aliquip_5d\": -21852184\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"pending\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"dolore_5\": [\n \"\",\n \"\"\n ],\n \"sunt_0\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"dolor3\": true\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"successful\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"unprocessable\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"ullamcoad\": [\n \"\",\n \"\"\n ],\n \"sunt_2c\": [\n \"\",\n \"\"\n ],\n \"dolore5\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"cillum20\": -69720093,\n \"ipsum_\": true,\n \"irurebe7\": true\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"error\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"ex_368\": [\n \"\",\n \"\"\n ],\n \"ad_a\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"ullamco_5\": \"in\",\n \"dolor1\": false\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"deleted\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"successes\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"Duisd_\": [\n \"\",\n \"\"\n ],\n \"incididunt_d\": [\n \"\",\n \"\"\n ],\n \"esse_b\": [\n \"\",\n \"\"\n ],\n \"sunt_6f\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"officiaf\": 76955829.64547545\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"successful\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"consectetur_18\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"dolored_\": 56945758.44976053\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"deleted\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"imported\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"nostrud9\": [\n \"\",\n \"\"\n ],\n \"anim_1c\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"eu_8\": false\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"pending\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"sed_d\": [\n \"\",\n \"\"\n ],\n \"sint9\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"nullad\": 92101989,\n \"eiusmod461\": true\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"skipped\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"pending\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"incididunt_3f\": [\n \"\",\n \"\"\n ],\n \"magna_7_6\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"non_d\": \"nulla laborum\",\n \"non__7\": \"ex ullamco\",\n \"nostrud8e\": true\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"imported\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"ea_c\": [\n \"\",\n \"\"\n ],\n \"anim_3\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"reprehenderit_298\": -56836598.25880705,\n \"nisiac\": \"Ut id\"\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"successful\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"skipped\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"officia___\": [\n \"\",\n \"\"\n ],\n \"sit_6\": [\n \"\",\n \"\"\n ],\n \"sita0\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"exercitation_d\": false\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"unprocessable\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"laboris_3\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"ut_f1\": -61512825,\n \"ad_1\": 86711545\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"skipped\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ],\n \"retryable\": [\n {\n \"row_number\": \"\",\n \"errors\": {\n \"quis_c5a\": [\n \"\",\n \"\"\n ],\n \"ut_1f\": [\n \"\",\n \"\"\n ],\n \"eiusmod_abc\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"ut_7_\": 58989188.32377258,\n \"occaecat_d\": true\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"retryable\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n },\n {\n \"row_number\": \"\",\n \"errors\": {\n \"in83\": [\n \"\",\n \"\"\n ],\n \"culpaf9\": [\n \"\",\n \"\"\n ],\n \"incididunt_0\": [\n \"\",\n \"\"\n ],\n \"Ut_be\": [\n \"\",\n \"\"\n ]\n },\n \"data\": {\n \"nostruded\": \"dolor consequat\",\n \"cillum_9\": 48823090\n },\n \"metadata\": {\n \"login_email_signals\": {\n \"personal\": {\n \"registered\": \"\"\n },\n \"sso_enforced\": \"\",\n \"work\": {\n \"registered\": \"\"\n }\n }\n },\n \"row_error_details\": {\n \"ambiguous\": [\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"slug\": \"\",\n \"employee_identifier\": \"\",\n \"pay_item\": \"\",\n \"amount\": \"\",\n \"effective_date\": \"\",\n \"end_date\": \"\",\n \"occurrence\": \"\",\n \"inserted_at\": \"\",\n \"created_by\": {\n \"slug\": \"\",\n \"name\": \"\"\n }\n }\n ]\n },\n \"row_errors\": {},\n \"status\": \"imported\",\n \"submission_errors\": [\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n },\n {\n \"messages\": [\n \"\",\n \"\"\n ],\n \"error\": \"\",\n \"field_name\": \"\"\n }\n ]\n }\n ]\n },\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\",\n \"counts_by_status\": {\n \"pending\": \"\",\n \"successful\": \"\",\n \"imported\": \"\",\n \"error\": \"\",\n \"unprocessable\": \"\",\n \"deleted\": \"\",\n \"skipped\": \"\",\n \"retryable\": \"\"\n },\n \"counts_by_column\": {\n \"ullamco_4e\": {\n \"error\": \"\",\n \"valid\": \"\"\n },\n \"velit0\": {\n \"error\": \"\",\n \"valid\": \"\"\n }\n },\n \"ordered_rows\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-9b9e32ca-1404-464a-94f8-6998b2807583" }, { "id": "709a5f3f-c915-4111-b4cd-78a440426622", "name": "Bad Request", "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/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "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": "job_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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-709a5f3f-c915-4111-b4cd-78a440426622" }, { "id": "7f10a228-18db-4b70-a098-830ec7051f94", "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/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "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": "job_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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-7f10a228-18db-4b70-a098-830ec7051f94" }, { "id": "dc657757-7203-4023-bf75-d890839f5382", "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/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "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": "job_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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-dc657757-7203-4023-bf75-d890839f5382" }, { "id": "2303eb91-041f-47f2-8c6e-cffbc3c98253", "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/bulk-employment-jobs/:job_id/rows?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id", "rows" ], "query": [ { "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": "job_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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-2303eb91-041f-47f2-8c6e-cffbc3c98253" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-e0bc823b-0502-4162-b530-169f2e609fff" } ], "id": "76004deb-23fe-4905-b688-414b4873a107", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-76004deb-23fe-4905-b688-414b4873a107" }, { "name": "Show bulk employment job", "id": "5170ef3f-7a0c-418b-9710-d3b1f8c1bd13", "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/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "id": "f51551a3-0cb4-4b13-9621-16f57d5e29d3", "key": "job_id", "value": "", "description": "(Required) Bulk employment job id" } ] }, "description": "## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "31c3e087-5bae-491c-806b-619292a530b6", "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/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"stage\": \"submission\",\n \"status\": \"failed\",\n \"name\": \"\",\n \"total_count\": \"\",\n \"processed_count\": \"\",\n \"failed_count\": \"\",\n \"inserted_at\": \"\",\n \"inserted_by\": {\n \"slug\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"personal_details\": {\n \"birthdate\": \"\",\n \"full_preferred_name\": \"\",\n \"gender\": \"\",\n \"gender_description\": \"\",\n \"given_name\": \"\",\n \"is_us_person\": \"\",\n \"mobile_number\": \"\",\n \"nationality\": [\n \"\",\n \"\"\n ],\n \"preferred_name\": \"\",\n \"preferred_pronouns\": \"\",\n \"recovery_number\": \"\",\n \"redacted_fields\": [\n \"\",\n \"\"\n ],\n \"sex\": \"\",\n \"surname\": \"\",\n \"title\": \"ms\"\n },\n \"profile_picture\": \"\",\n \"status\": \"cancelled\"\n },\n \"updated_at\": \"\",\n \"finished_at\": \"\",\n \"metadata\": {},\n \"column_mapping\": {\n \"mapping\": {},\n \"source_columns\": [\n {\n \"name\": \"\",\n \"index\": \"\",\n \"sample_data\": \"\"\n },\n {\n \"name\": \"\",\n \"index\": \"\",\n \"sample_data\": \"\"\n }\n ],\n \"unmapped_column_count\": \"\",\n \"unmapped_required_field_count\": \"\",\n \"auto_mapped_columns\": [\n \"\",\n \"\"\n ]\n },\n \"display_name\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"imported_count\": \"\",\n \"legal_entity\": {\n \"name\": \"\",\n \"slug\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-31c3e087-5bae-491c-806b-619292a530b6" }, { "id": "08fe1cb9-d85d-482f-889a-12dbd3134bff", "name": "Bad Request", "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/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-08fe1cb9-d85d-482f-889a-12dbd3134bff" }, { "id": "de0fb76c-3356-4b65-b6ad-19440205ccd6", "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/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-de0fb76c-3356-4b65-b6ad-19440205ccd6" }, { "id": "c12ee6b3-f99d-4cf0-8b10-0f035b5bdbf0", "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/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-c12ee6b3-f99d-4cf0-8b10-0f035b5bdbf0" }, { "id": "8e36a8b7-fb41-4f87-b2ed-3e080332abb9", "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/bulk-employment-jobs/:job_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs", ":job_id" ], "variable": [ { "key": "job_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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-8e36a8b7-fb41-4f87-b2ed-3e080332abb9" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-5170ef3f-7a0c-418b-9710-d3b1f8c1bd13" } ], "id": "28e652b6-a9c9-40bb-8775-3c317f5182e8", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-28e652b6-a9c9-40bb-8775-3c317f5182e8" }, { "name": "Create bulk employment job", "id": "b21fe993-e1b6-41c0-b615-4c91d3ed148e", "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 \"country_code\": \"\",\n \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] }, "description": "Creates a job to bulk-create employments for multiple employees at once. Each employee payload must match the employment schema for the selected country.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "bdd7b117-874c-4559-8efb-19c26ce18e6b", "name": "Accepted", "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 \"country_code\": \"\",\n \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"stage\": \"submission\",\n \"status\": \"failed\",\n \"name\": \"\",\n \"total_count\": \"\",\n \"processed_count\": \"\",\n \"failed_count\": \"\",\n \"inserted_at\": \"\",\n \"inserted_by\": {\n \"slug\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"personal_details\": {\n \"birthdate\": \"\",\n \"full_preferred_name\": \"\",\n \"gender\": \"\",\n \"gender_description\": \"\",\n \"given_name\": \"\",\n \"is_us_person\": \"\",\n \"mobile_number\": \"\",\n \"nationality\": [\n \"\",\n \"\"\n ],\n \"preferred_name\": \"\",\n \"preferred_pronouns\": \"\",\n \"recovery_number\": \"\",\n \"redacted_fields\": [\n \"\",\n \"\"\n ],\n \"sex\": \"\",\n \"surname\": \"\",\n \"title\": \"ms\"\n },\n \"profile_picture\": \"\",\n \"status\": \"cancelled\"\n },\n \"updated_at\": \"\",\n \"finished_at\": \"\",\n \"metadata\": {},\n \"column_mapping\": {\n \"mapping\": {},\n \"source_columns\": [\n {\n \"name\": \"\",\n \"index\": \"\",\n \"sample_data\": \"\"\n },\n {\n \"name\": \"\",\n \"index\": \"\",\n \"sample_data\": \"\"\n }\n ],\n \"unmapped_column_count\": \"\",\n \"unmapped_required_field_count\": \"\",\n \"auto_mapped_columns\": [\n \"\",\n \"\"\n ]\n },\n \"display_name\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ],\n \"imported_count\": \"\",\n \"legal_entity\": {\n \"name\": \"\",\n \"slug\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-bdd7b117-874c-4559-8efb-19c26ce18e6b" }, { "id": "971405c6-d388-40db-b074-80dc15324548", "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 \"country_code\": \"\",\n \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-971405c6-d388-40db-b074-80dc15324548" }, { "id": "b3f602af-0f4a-4e9c-8844-a0ebce96f63a", "name": "Forbidden", "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 \"country_code\": \"\",\n \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-b3f602af-0f4a-4e9c-8844-a0ebce96f63a" }, { "id": "cb8e1f9a-7d2b-4db1-a129-0a6c2038ddaf", "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 \"country_code\": \"\",\n \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-cb8e1f9a-7d2b-4db1-a129-0a6c2038ddaf" }, { "id": "393af339-93e4-4163-ab75-526b460e812b", "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 \"country_code\": \"\",\n \"employees\": [\n {\n \"activate_global_payroll\": \"\",\n \"send_invitation\": \"\"\n }\n ],\n \"send_invitation\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/bulk-employment-jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bulk-employment-jobs" ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-393af339-93e4-4163-ab75-526b460e812b" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-b21fe993-e1b6-41c0-b615-4c91d3ed148e" } ], "id": "7e9cc5ea-db9d-4044-a953-3fe8847228ee", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-7e9cc5ea-db9d-4044-a953-3fe8847228ee" }, { "name": "ready", "item": [ { "name": "Complete onboarding", "id": "a1c9d128-d0a6-4fa1-8f6f-17059ce67dbf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] }, "description": "Completes the employee onboarding. When all tasks are completed, the employee is marked as in `review` status" }, "response": [ { "id": "2fa203d9-0dfa-47e6-8061-4317201d6482", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employment\": {\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": [],\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"cor\"\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 \"created_at\": \"\",\n \"emergency_contact_details\": {},\n \"files\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"full_name\": \"\",\n \"id\": \"\",\n \"type\": \"global_payroll_employee\",\n \"employment_model\": \"peo\",\n \"work_address_details\": {},\n \"job_title\": \"\",\n \"manager_email\": \"\",\n \"manager_employment_id\": \"\",\n \"onboarding_tasks\": {\n \"address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"active\",\n \"employment_lifecycle_stage\": \"contract_signing\",\n \"updated_at\": \"\",\n \"work_email\": \"\",\n \"eligible_for_onboarding_cancellation\": \"\",\n \"short_id\": \"\",\n \"department\": \"\",\n \"provisional_start_date\": \"\",\n \"contractor_settings\": {\n \"requires_work_confirmation\": \"\"\n },\n \"contractor_type\": \"standard\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\n },\n \"expiration_date\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"basic_information\": {},\n \"probation_period_end_date\": \"\",\n \"department_id\": \"\",\n \"manager\": \"\",\n \"external_id\": \"\",\n \"user_status\": \"active\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-2fa203d9-0dfa-47e6-8061-4317201d6482" }, { "id": "504fc9cc-d437-4388-8497-92f96923acbc", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-504fc9cc-d437-4388-8497-92f96923acbc" }, { "id": "8ef56925-6a1e-4c9f-8c2d-46792210bee8", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-8ef56925-6a1e-4c9f-8c2d-46792210bee8" }, { "id": "73ff5457-a4b0-4db0-896d-1f8db222fe28", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-73ff5457-a4b0-4db0-896d-1f8db222fe28" }, { "id": "e1eca905-33f7-4610-b0fb-2ab97c5be4aa", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-e1eca905-33f7-4610-b0fb-2ab97c5be4aa" }, { "id": "a4413189-dc41-45d8-8758-5172507dab20", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"employment_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/ready", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ready" ] } }, "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-a4413189-dc41-45d8-8758-5172507dab20" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-a1c9d128-d0a6-4fa1-8f6f-17059ce67dbf" } ], "id": "aed22677-7c1c-4912-8d91-3a3295ae2c6e", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-aed22677-7c1c-4912-8d91-3a3295ae2c6e" } ], "id": "a06ea181-5d9c-45d3-b7d2-9d003fc5737f", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-a06ea181-5d9c-45d3-b7d2-9d003fc5737f" }, { "name": "v2", "item": [ { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "Update employment", "id": "bae243d5-825c-4749-8505-f7ff8e10e358", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "variable": [ { "id": "2065fd43-9aee-47b2-8676-2165dbfe2270", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] } }, "response": [ { "id": "95c13eb8-fb0d-4b63-abc2-494216dae7b3", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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\": {\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": [],\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"cor\"\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 \"created_at\": \"\",\n \"emergency_contact_details\": {},\n \"files\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"full_name\": \"\",\n \"id\": \"\",\n \"type\": \"global_payroll_employee\",\n \"employment_model\": \"peo\",\n \"work_address_details\": {},\n \"job_title\": \"\",\n \"manager_email\": \"\",\n \"manager_employment_id\": \"\",\n \"onboarding_tasks\": {\n \"address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"active\",\n \"employment_lifecycle_stage\": \"contract_signing\",\n \"updated_at\": \"\",\n \"work_email\": \"\",\n \"eligible_for_onboarding_cancellation\": \"\",\n \"short_id\": \"\",\n \"department\": \"\",\n \"provisional_start_date\": \"\",\n \"contractor_settings\": {\n \"requires_work_confirmation\": \"\"\n },\n \"contractor_type\": \"standard\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\n },\n \"expiration_date\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"basic_information\": {},\n \"probation_period_end_date\": \"\",\n \"department_id\": \"\",\n \"manager\": \"\",\n \"external_id\": \"\",\n \"user_status\": \"active\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-95c13eb8-fb0d-4b63-abc2-494216dae7b3" }, { "id": "6bc8c10c-8c22-416a-877f-64ccc7dd2956", "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-6bc8c10c-8c22-416a-877f-64ccc7dd2956" }, { "id": "5e1a15f6-e631-4690-a0ee-8ea52411a6e1", "name": "Forbidden", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-5e1a15f6-e631-4690-a0ee-8ea52411a6e1" }, { "id": "70a922b2-9a15-42c3-808b-99e0165e138e", "name": "Conflict", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-70a922b2-9a15-42c3-808b-99e0165e138e" }, { "id": "2f32c548-2e92-4f34-95b3-7166e90a497a", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-2f32c548-2e92-4f34-95b3-7166e90a497a" }, { "id": "6b6ac029-a1c7-447e-8b8f-50ed21026683", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-6b6ac029-a1c7-447e-8b8f-50ed21026683" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-bae243d5-825c-4749-8505-f7ff8e10e358" }, { "name": "Update employment", "id": "5de624ef-aa60-4af6-acac-783ba23e4936", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "variable": [ { "id": "17de0d21-cf37-45e6-974f-87fef6f12aa2", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] } }, "response": [ { "id": "d9b7d278-44ed-4dbe-bc21-0d48df667387", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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\": {\n \"address_details\": {},\n \"administrative_details\": {},\n \"bank_account_details\": [],\n \"billing_address_details\": {},\n \"company_id\": \"\",\n \"contract_details\": {},\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"cor\"\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 \"created_at\": \"\",\n \"emergency_contact_details\": {},\n \"files\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"full_name\": \"\",\n \"id\": \"\",\n \"type\": \"global_payroll_employee\",\n \"employment_model\": \"peo\",\n \"work_address_details\": {},\n \"job_title\": \"\",\n \"manager_email\": \"\",\n \"manager_employment_id\": \"\",\n \"onboarding_tasks\": {\n \"address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"administrative_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"bank_account_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"billing_address_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"contract_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"emergency_contact_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"employment_document_details\": {\n \"description\": \"\",\n \"status\": \"pending\"\n },\n \"personal_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n },\n \"pricing_plan_details\": {\n \"description\": \"\",\n \"status\": \"completed\"\n }\n },\n \"personal_details\": {},\n \"personal_email\": \"\",\n \"login_email\": \"\",\n \"pricing_plan_details\": {\n \"frequency\": \"monthly\"\n },\n \"status\": \"active\",\n \"employment_lifecycle_stage\": \"contract_signing\",\n \"updated_at\": \"\",\n \"work_email\": \"\",\n \"eligible_for_onboarding_cancellation\": \"\",\n \"short_id\": \"\",\n \"department\": \"\",\n \"provisional_start_date\": \"\",\n \"contractor_settings\": {\n \"requires_work_confirmation\": \"\"\n },\n \"contractor_type\": \"standard\",\n \"contractor_rate\": {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"pay_frequency\": \"monthly\",\n \"slug\": \"\",\n \"type\": \"monthly\"\n },\n \"expiration_date\": \"\",\n \"bill_to_legal_entity_id\": \"\",\n \"basic_information\": {},\n \"probation_period_end_date\": \"\",\n \"department_id\": \"\",\n \"manager\": \"\",\n \"external_id\": \"\",\n \"user_status\": \"active\",\n \"seniority_date\": \"\",\n \"active_contract_id\": \"\",\n \"engaged_by_legal_entity_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-d9b7d278-44ed-4dbe-bc21-0d48df667387" }, { "id": "40564ae9-a272-4b8c-b11a-a84cb41f3066", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-40564ae9-a272-4b8c-b11a-a84cb41f3066" }, { "id": "27d6d614-f84d-4895-9bb1-b85e8ce1b7ff", "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-27d6d614-f84d-4895-9bb1-b85e8ce1b7ff" }, { "id": "15dc09e5-7f7b-4d32-a648-f3f0c9100dd0", "name": "Conflict", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-15dc09e5-7f7b-4d32-a648-f3f0c9100dd0" }, { "id": "90f6ef9d-7bdc-485a-a2e5-f22be05d2bd6", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-90f6ef9d-7bdc-485a-a2e5-f22be05d2bd6" }, { "id": "2f5a99b0-e368-45d0-bfb5-a55d150431c7", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"department_id\": \"\",\n \"external_id\": \"\",\n \"manager_id\": \"\",\n \"work_email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/employments/:employment_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "employments", ":employment_id" ], "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:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-2f5a99b0-e368-45d0-bfb5-a55d150431c7" } ], "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-5de624ef-aa60-4af6-acac-783ba23e4936" } ], "id": "a4f30318-8d65-43af-841f-c4132d3b57eb", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-a4f30318-8d65-43af-841f-c4132d3b57eb" } ], "id": "f0f6a428-4111-459b-8448-4f2dc75b552c", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-f0f6a428-4111-459b-8448-4f2dc75b552c" } ], "id": "7e2329e2-56d9-472d-bd0a-c758b447a505", "createdAt": "2026-07-28T02:45:59.000Z", "updatedAt": "2026-07-28T02:45:59.000Z", "uid": "35240-7e2329e2-56d9-472d-bd0a-c758b447a505" } ], "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/" } ] }