{ "info": { "_postman_id": "d990339a-d0ec-4b28-b66c-e515750bbc4c", "name": "Remote Address Details Offboarding API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:46:49.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "lastUpdatedBy": "35240", "uid": "35240-d990339a-d0ec-4b28-b66c-e515750bbc4c" }, "item": [ { "name": "v1", "item": [ { "name": "offboardings", "item": [ { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "List Offboardings for Employment", "id": "cc68549a-760d-43a9-bc1c-6a4099e6c5c4", "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/offboardings/employments/:employment_id?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", "employments", ":employment_id" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ], "variable": [ { "id": "fef64ef4-ebb7-402a-8aa1-657495edb15a", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Lists Offboarding requests for a specific employment.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |\n" }, "response": [ { "id": "ea7bf886-f4dc-4f91-a950-2771a0d736c1", "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/offboardings/employments/:employment_id?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", "employments", ":employment_id" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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 \"current_page\": \"\",\n \"offboardings\": [\n {\n \"id\": \"\",\n \"type\": \"resignation\",\n \"status\": \"in_review\",\n \"submitted_at\": \"\",\n \"employment_id\": \"\",\n \"requested_by\": \"\",\n \"proposed_last_working_day\": \"\",\n \"termination_date\": \"\",\n \"resignation_reason\": \"conversion_to_peo\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employer_awareness\": \"\",\n \"offboarding_id\": \"\",\n \"reason_description\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"resignation\",\n \"status\": \"done\",\n \"submitted_at\": \"\",\n \"employment_id\": \"\",\n \"requested_by\": \"\",\n \"proposed_last_working_day\": \"\",\n \"termination_date\": \"\",\n \"resignation_reason\": \"transfer_between_remote_customer\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employer_awareness\": \"\",\n \"offboarding_id\": \"\",\n \"reason_description\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-ea7bf886-f4dc-4f91-a950-2771a0d736c1" }, { "id": "999698ac-795d-4703-8fa5-d9b5d26d7358", "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/offboardings/employments/:employment_id?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", "employments", ":employment_id" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-999698ac-795d-4703-8fa5-d9b5d26d7358" }, { "id": "d8a0e455-808f-4bc5-918a-d28f723a3e17", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/offboardings/employments/:employment_id?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", "employments", ":employment_id" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-d8a0e455-808f-4bc5-918a-d28f723a3e17" }, { "id": "1241dca4-f577-424e-87a1-c2a02dea78aa", "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/offboardings/employments/:employment_id?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", "employments", ":employment_id" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-1241dca4-f577-424e-87a1-c2a02dea78aa" }, { "id": "77e158e9-729a-4385-a04f-8ef80e61bc18", "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/offboardings/employments/:employment_id?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", "employments", ":employment_id" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-77e158e9-729a-4385-a04f-8ef80e61bc18" }, { "id": "f4c83990-c3cb-43d6-8904-ba61f090501d", "name": "Too many requests", "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/offboardings/employments/:employment_id?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", "employments", ":employment_id" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-f4c83990-c3cb-43d6-8904-ba61f090501d" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-cc68549a-760d-43a9-bc1c-6a4099e6c5c4" } ], "id": "93a96638-a2b3-42d4-bcd4-c043cc2e1e63", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-93a96638-a2b3-42d4-bcd4-c043cc2e1e63" } ], "id": "c65a0247-0c4b-458a-8aee-225e30f8a3be", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-c65a0247-0c4b-458a-8aee-225e30f8a3be" }, { "name": "{id}", "item": [ { "name": "Show Offboarding", "id": "4a4ab533-aca6-4493-acec-400d11f975c2", "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/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", ":id" ], "variable": [ { "id": "a750d52c-7455-44ea-ab58-dbb9e6fe13f2", "key": "id", "value": "", "description": "(Required) Offboarding request ID" } ] }, "description": "Shows an Offboarding request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |\n" }, "response": [ { "id": "f7492bad-9475-4aeb-a00d-00aed44a34ce", "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/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"offboarding\": {\n \"id\": \"\",\n \"type\": \"resignation\",\n \"status\": \"submitted\",\n \"submitted_at\": \"\",\n \"employment_id\": \"\",\n \"requested_by\": \"\",\n \"proposed_last_working_day\": \"\",\n \"termination_date\": \"\",\n \"resignation_reason\": \"other\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employer_awareness\": \"\",\n \"offboarding_id\": \"\",\n \"reason_description\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-f7492bad-9475-4aeb-a00d-00aed44a34ce" }, { "id": "97c080a5-a1aa-4822-a212-a5a2eb87e377", "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/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", ":id" ], "variable": [ { "key": "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-97c080a5-a1aa-4822-a212-a5a2eb87e377" }, { "id": "3c7ae4d8-e725-4631-8d5f-a3345e869925", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-3c7ae4d8-e725-4631-8d5f-a3345e869925" }, { "id": "78d44c38-14bc-49d4-8120-9b2c5ba67dc0", "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/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-78d44c38-14bc-49d4-8120-9b2c5ba67dc0" }, { "id": "ddb7c28c-84ed-4ff5-849b-c2867fa76ed7", "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/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-ddb7c28c-84ed-4ff5-849b-c2867fa76ed7" }, { "id": "770129b1-a641-42f9-8422-eb1ada82de6a", "name": "Too many requests", "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/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings", ":id" ], "variable": [ { "key": "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-770129b1-a641-42f9-8422-eb1ada82de6a" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-4a4ab533-aca6-4493-acec-400d11f975c2" } ], "id": "471ea535-419b-4880-9d8d-398bc6633843", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-471ea535-419b-4880-9d8d-398bc6633843" }, { "name": "List Offboarding", "id": "6efee79e-fa63-4b2a-b810-cafe972ba81e", "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/offboardings?employment_id=&type=&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type", "key": "type", "value": "" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] }, "description": "Lists Offboarding requests.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |\n" }, "response": [ { "id": "0e37e088-492d-4bfb-9d33-42c317da8488", "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/offboardings?employment_id=&type=&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type", "key": "type", "value": "" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"offboardings\": [\n {\n \"id\": \"\",\n \"type\": \"resignation\",\n \"status\": \"in_review\",\n \"submitted_at\": \"\",\n \"employment_id\": \"\",\n \"requested_by\": \"\",\n \"proposed_last_working_day\": \"\",\n \"termination_date\": \"\",\n \"resignation_reason\": \"conversion_to_peo\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employer_awareness\": \"\",\n \"offboarding_id\": \"\",\n \"reason_description\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"resignation\",\n \"status\": \"done\",\n \"submitted_at\": \"\",\n \"employment_id\": \"\",\n \"requested_by\": \"\",\n \"proposed_last_working_day\": \"\",\n \"termination_date\": \"\",\n \"resignation_reason\": \"transfer_between_remote_customer\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employer_awareness\": \"\",\n \"offboarding_id\": \"\",\n \"reason_description\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-0e37e088-492d-4bfb-9d33-42c317da8488" }, { "id": "61687e68-2da7-4269-8dc1-6879afb1f124", "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/offboardings?employment_id=&type=&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type", "key": "type", "value": "" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-61687e68-2da7-4269-8dc1-6879afb1f124" }, { "id": "e3a46db2-3e54-4562-a157-d9c6c85761c3", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/offboardings?employment_id=&type=&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type", "key": "type", "value": "" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-e3a46db2-3e54-4562-a157-d9c6c85761c3" }, { "id": "bebb3bed-8ca5-4330-8f24-07acf2c62f78", "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/offboardings?employment_id=&type=&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type", "key": "type", "value": "" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-bebb3bed-8ca5-4330-8f24-07acf2c62f78" }, { "id": "75ab19b7-a38b-4aa3-b365-d6030429312e", "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/offboardings?employment_id=&type=&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type", "key": "type", "value": "" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-75ab19b7-a38b-4aa3-b365-d6030429312e" }, { "id": "fe3d624e-26db-4ec7-ad1a-e280b053250b", "name": "Too many requests", "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/offboardings?employment_id=&type=&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type", "key": "type", "value": "" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-fe3d624e-26db-4ec7-ad1a-e280b053250b" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-6efee79e-fa63-4b2a-b810-cafe972ba81e" }, { "name": "Create Offboarding", "id": "cbe7d43b-358c-4e14-b4bb-8d8430b4943d", "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 \"type\": \"termination\",\n \"employment_id\": \"\",\n \"termination_details\": {\n \"confidential\": \"\",\n \"proposed_termination_date\": \"\",\n \"termination_reason\": \"dissatisfaction_with_remote_service\",\n \"risk_assessment_reasons\": [\n \"caring_responsibilities\"\n ],\n \"will_challenge_termination\": \"\",\n \"reason_description\": \"\",\n \"acknowledge_termination_procedure\": \"\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"customer_informed_employee\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"personal_email\": \"\",\n \"termination_reason_files\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_challenge_termination_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/offboardings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ] }, "description": "Creates an Offboarding request\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage offboarding (`offboarding:write`) |\n" }, "response": [ { "id": "e60b8243-dbe3-4fbc-a468-67b8edb62b0e", "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 \"type\": \"termination\",\n \"employment_id\": \"\",\n \"termination_details\": {\n \"confidential\": \"\",\n \"proposed_termination_date\": \"\",\n \"termination_reason\": \"dissatisfaction_with_remote_service\",\n \"risk_assessment_reasons\": [\n \"caring_responsibilities\"\n ],\n \"will_challenge_termination\": \"\",\n \"reason_description\": \"\",\n \"acknowledge_termination_procedure\": \"\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"customer_informed_employee\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"personal_email\": \"\",\n \"termination_reason_files\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_challenge_termination_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/offboardings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"offboarding\": {\n \"id\": \"\",\n \"type\": \"resignation\",\n \"status\": \"submitted\",\n \"submitted_at\": \"\",\n \"employment_id\": \"\",\n \"requested_by\": \"\",\n \"proposed_last_working_day\": \"\",\n \"termination_date\": \"\",\n \"resignation_reason\": \"other\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employer_awareness\": \"\",\n \"offboarding_id\": \"\",\n \"reason_description\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-e60b8243-dbe3-4fbc-a468-67b8edb62b0e" }, { "id": "be2d9d5e-e18e-4a28-b168-816aa69c9aa1", "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 \"type\": \"termination\",\n \"employment_id\": \"\",\n \"termination_details\": {\n \"confidential\": \"\",\n \"proposed_termination_date\": \"\",\n \"termination_reason\": \"dissatisfaction_with_remote_service\",\n \"risk_assessment_reasons\": [\n \"caring_responsibilities\"\n ],\n \"will_challenge_termination\": \"\",\n \"reason_description\": \"\",\n \"acknowledge_termination_procedure\": \"\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"customer_informed_employee\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"personal_email\": \"\",\n \"termination_reason_files\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_challenge_termination_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/offboardings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ] } }, "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-be2d9d5e-e18e-4a28-b168-816aa69c9aa1" }, { "id": "e884fd00-6948-4b05-91d3-af42cff632b2", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"termination\",\n \"employment_id\": \"\",\n \"termination_details\": {\n \"confidential\": \"\",\n \"proposed_termination_date\": \"\",\n \"termination_reason\": \"dissatisfaction_with_remote_service\",\n \"risk_assessment_reasons\": [\n \"caring_responsibilities\"\n ],\n \"will_challenge_termination\": \"\",\n \"reason_description\": \"\",\n \"acknowledge_termination_procedure\": \"\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"customer_informed_employee\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"personal_email\": \"\",\n \"termination_reason_files\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_challenge_termination_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/offboardings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-e884fd00-6948-4b05-91d3-af42cff632b2" }, { "id": "dce1bb1e-0c85-4aac-8a30-4fc8a8456265", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"termination\",\n \"employment_id\": \"\",\n \"termination_details\": {\n \"confidential\": \"\",\n \"proposed_termination_date\": \"\",\n \"termination_reason\": \"dissatisfaction_with_remote_service\",\n \"risk_assessment_reasons\": [\n \"caring_responsibilities\"\n ],\n \"will_challenge_termination\": \"\",\n \"reason_description\": \"\",\n \"acknowledge_termination_procedure\": \"\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"customer_informed_employee\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"personal_email\": \"\",\n \"termination_reason_files\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_challenge_termination_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/offboardings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ] } }, "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-dce1bb1e-0c85-4aac-8a30-4fc8a8456265" }, { "id": "25f4314d-4301-45c9-8d96-5ac99e2182a1", "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 \"type\": \"termination\",\n \"employment_id\": \"\",\n \"termination_details\": {\n \"confidential\": \"\",\n \"proposed_termination_date\": \"\",\n \"termination_reason\": \"dissatisfaction_with_remote_service\",\n \"risk_assessment_reasons\": [\n \"caring_responsibilities\"\n ],\n \"will_challenge_termination\": \"\",\n \"reason_description\": \"\",\n \"acknowledge_termination_procedure\": \"\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"customer_informed_employee\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"personal_email\": \"\",\n \"termination_reason_files\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_challenge_termination_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/offboardings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ] } }, "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-25f4314d-4301-45c9-8d96-5ac99e2182a1" }, { "id": "cc13a6ae-567c-49bd-a214-47b8547e0a89", "name": "Too many requests", "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 \"type\": \"termination\",\n \"employment_id\": \"\",\n \"termination_details\": {\n \"confidential\": \"\",\n \"proposed_termination_date\": \"\",\n \"termination_reason\": \"dissatisfaction_with_remote_service\",\n \"risk_assessment_reasons\": [\n \"caring_responsibilities\"\n ],\n \"will_challenge_termination\": \"\",\n \"reason_description\": \"\",\n \"acknowledge_termination_procedure\": \"\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"customer_informed_employee\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"personal_email\": \"\",\n \"termination_reason_files\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_challenge_termination_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/offboardings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ] } }, "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-cc13a6ae-567c-49bd-a214-47b8547e0a89" }, { "id": "545107aa-6dfc-4301-9c1c-4440c632d0f9", "name": "Internal Server Error", "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 \"type\": \"termination\",\n \"employment_id\": \"\",\n \"termination_details\": {\n \"confidential\": \"\",\n \"proposed_termination_date\": \"\",\n \"termination_reason\": \"dissatisfaction_with_remote_service\",\n \"risk_assessment_reasons\": [\n \"caring_responsibilities\"\n ],\n \"will_challenge_termination\": \"\",\n \"reason_description\": \"\",\n \"acknowledge_termination_procedure\": \"\",\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"customer_informed_employee\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"personal_email\": \"\",\n \"termination_reason_files\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_challenge_termination_description\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/offboardings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "offboardings" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"code\": \"\",\n \"message\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-545107aa-6dfc-4301-9c1c-4440c632d0f9" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-cbe7d43b-358c-4e14-b4bb-8d8430b4943d" } ], "id": "3bff6228-5654-4faf-904e-b7e06412e027", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-3bff6228-5654-4faf-904e-b7e06412e027" }, { "name": "work-authorization-requests", "item": [ { "name": "{id}", "item": [ { "name": "Show work authorization request", "id": "83b6b41d-5fc0-4f22-ba49-911506b56404", "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/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "id": "d22cfaf4-f18f-40f1-8568-0fb71327e84d", "key": "id", "value": "", "description": "(Required) work authorization request ID" } ] }, "description": "Show a single work authorization request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) |\n" }, "response": [ { "id": "4216d102-7994-48f8-b1ee-78d72a3750f4", "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/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"work_authorization_request\": {\n \"additional_information\": \"\",\n \"destination_country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\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 \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"status\": \"approved_by_manager\",\n \"submitted_at\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"will_negotiate_or_sign_contracts\": \"\",\n \"work_location\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-4216d102-7994-48f8-b1ee-78d72a3750f4" }, { "id": "e6dbded5-fe23-4d42-8df3-b2f26c343e38", "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/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-e6dbded5-fe23-4d42-8df3-b2f26c343e38" }, { "id": "5cda69c3-e690-4eb5-8e27-4ed57c31aa5e", "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/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-5cda69c3-e690-4eb5-8e27-4ed57c31aa5e" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-83b6b41d-5fc0-4f22-ba49-911506b56404" }, { "name": "Update work authorization request", "id": "9de4ff9a-b8c2-482c-b75e-22bea89ce330", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "id": "49a1452e-cd6e-41a1-a282-7e00156565e0", "key": "id", "value": "", "description": "(Required) work authorization request ID" } ] }, "description": "Updates a work authorization request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) |\n" }, "response": [ { "id": "bc4364b7-b995-4f95-9aa8-1ae50e5a213f", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"work_authorization_request\": {\n \"additional_information\": \"\",\n \"destination_country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\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 \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"status\": \"approved_by_manager\",\n \"submitted_at\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"will_negotiate_or_sign_contracts\": \"\",\n \"work_location\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-bc4364b7-b995-4f95-9aa8-1ae50e5a213f" }, { "id": "4d39b1f1-686f-41c3-96b8-e2f47661e7ad", "name": "Unauthorized", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-4d39b1f1-686f-41c3-96b8-e2f47661e7ad" }, { "id": "c167b99c-7900-462b-b3b8-747452986245", "name": "Not Found", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-c167b99c-7900-462b-b3b8-747452986245" }, { "id": "c32d7fdd-42f8-4d34-8115-7ceeaeae3183", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-c32d7fdd-42f8-4d34-8115-7ceeaeae3183" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-9de4ff9a-b8c2-482c-b75e-22bea89ce330" }, { "name": "Update work authorization request", "id": "55d81365-8d39-4469-be00-60ed0baa6270", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "id": "76707854-3cbb-42e3-9631-ad87811e5fbc", "key": "id", "value": "", "description": "(Required) work authorization request ID" } ] }, "description": "Updates a work authorization request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) |\n" }, "response": [ { "id": "d0df69a8-a605-4b5c-8482-c681f934431b", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"work_authorization_request\": {\n \"additional_information\": \"\",\n \"destination_country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\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 \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"status\": \"approved_by_manager\",\n \"submitted_at\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"will_negotiate_or_sign_contracts\": \"\",\n \"work_location\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-d0df69a8-a605-4b5c-8482-c681f934431b" }, { "id": "78a21ca3-2275-44f2-97df-e2bf8c52501e", "name": "Unauthorized", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-78a21ca3-2275-44f2-97df-e2bf8c52501e" }, { "id": "16e06676-1f1b-4190-802a-09832b704b2d", "name": "Not Found", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-16e06676-1f1b-4190-802a-09832b704b2d" }, { "id": "ca0d813b-a11a-4ac6-898d-f5bd0820d5e3", "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 \"status\": \"approved_by_manager\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/work-authorization-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-ca0d813b-a11a-4ac6-898d-f5bd0820d5e3" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-55d81365-8d39-4469-be00-60ed0baa6270" } ], "id": "c0a0d99f-1e12-4d09-a7ef-e62ae462cb12", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-c0a0d99f-1e12-4d09-a7ef-e62ae462cb12" }, { "name": "List work authorization requests", "id": "98ca3723-f2b1-4ad7-8666-edff426fd089", "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/work-authorization-requests?status=cancelled&employment_id=&employee_name=&order=desc&sort_by=submitted_at&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests" ], "query": [ { "description": "Filter results on the given status", "key": "status", "value": "cancelled" }, { "description": "Filter results on the given employment slug", "key": "employment_id", "value": "" }, { "description": "Filter results on the given employee name", "key": "employee_name", "value": "" }, { "description": "Sort order", "key": "order", "value": "desc" }, { "description": "Field to sort by", "key": "sort_by", "value": "submitted_at" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "List work authorization requests.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) |\n" }, "response": [ { "id": "4620faee-a9d3-45de-8b4e-a9ab524c61b7", "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/work-authorization-requests?status=cancelled&employment_id=&employee_name=&order=desc&sort_by=submitted_at&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests" ], "query": [ { "description": "Filter results on the given status", "key": "status", "value": "cancelled" }, { "description": "Filter results on the given employment slug", "key": "employment_id", "value": "" }, { "description": "Filter results on the given employee name", "key": "employee_name", "value": "" }, { "description": "Sort order", "key": "order", "value": "desc" }, { "description": "Field to sort by", "key": "sort_by", "value": "submitted_at" }, { "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 \"total_count\": \"\",\n \"total_pages\": \"\",\n \"work_authorization_requests\": [\n {\n \"additional_information\": \"\",\n \"destination_country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\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 \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"status\": \"declined_by_remote\",\n \"submitted_at\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"will_negotiate_or_sign_contracts\": \"\",\n \"work_location\": \"\"\n },\n {\n \"additional_information\": \"\",\n \"destination_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 \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"status\": \"declined_by_remote\",\n \"submitted_at\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"will_negotiate_or_sign_contracts\": \"\",\n \"work_location\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-4620faee-a9d3-45de-8b4e-a9ab524c61b7" }, { "id": "40d94f32-c00c-4793-9f2f-70df08b304c8", "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/work-authorization-requests?status=cancelled&employment_id=&employee_name=&order=desc&sort_by=submitted_at&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests" ], "query": [ { "description": "Filter results on the given status", "key": "status", "value": "cancelled" }, { "description": "Filter results on the given employment slug", "key": "employment_id", "value": "" }, { "description": "Filter results on the given employee name", "key": "employee_name", "value": "" }, { "description": "Sort order", "key": "order", "value": "desc" }, { "description": "Field to sort by", "key": "sort_by", "value": "submitted_at" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-40d94f32-c00c-4793-9f2f-70df08b304c8" }, { "id": "30035e2d-9a3b-4979-b801-d2f532dc548c", "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/work-authorization-requests?status=cancelled&employment_id=&employee_name=&order=desc&sort_by=submitted_at&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "work-authorization-requests" ], "query": [ { "description": "Filter results on the given status", "key": "status", "value": "cancelled" }, { "description": "Filter results on the given employment slug", "key": "employment_id", "value": "" }, { "description": "Filter results on the given employee name", "key": "employee_name", "value": "" }, { "description": "Sort order", "key": "order", "value": "desc" }, { "description": "Field to sort by", "key": "sort_by", "value": "submitted_at" }, { "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-30035e2d-9a3b-4979-b801-d2f532dc548c" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-98ca3723-f2b1-4ad7-8666-edff426fd089" } ], "id": "4d890a3e-792e-43c4-a2b9-9ffc2dacc80c", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-4d890a3e-792e-43c4-a2b9-9ffc2dacc80c" }, { "name": "resignations", "item": [ { "name": "{offboarding_request_id}", "item": [ { "name": "resignation-letter", "item": [ { "name": "Download a resignation letter", "id": "eb44b4b7-a5c8-44ba-955d-4e6c6fcebc2b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/msword" } ], "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/resignation-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "resignation-letter" ], "variable": [ { "id": "d6f0fa5a-b82c-4e39-a78a-92f189abb64c", "key": "offboarding_request_id", "value": "", "description": "(Required) Offboarding request ID" } ] }, "description": "Downloads a resignation letter from an employment request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View resignation letters (`resignation_letter:read`) | - |\n" }, "response": [ { "id": "cf05c6ba-1941-4aab-bbf4-6f8864f164f9", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/msword" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/resignation-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "resignation-letter" ], "variable": [ { "key": "offboarding_request_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/msword" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-cf05c6ba-1941-4aab-bbf4-6f8864f164f9" }, { "id": "8bf2bd22-e019-4a41-8381-c61696fa995f", "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/resignations/:offboarding_request_id/resignation-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "resignation-letter" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-8bf2bd22-e019-4a41-8381-c61696fa995f" }, { "id": "3ad01342-bc99-49a3-99f7-d5e660b5c5c4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/resignation-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "resignation-letter" ], "variable": [ { "key": "offboarding_request_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-3ad01342-bc99-49a3-99f7-d5e660b5c5c4" }, { "id": "6750dfda-2a1d-4623-bb81-b7c7ef628b59", "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/resignations/:offboarding_request_id/resignation-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "resignation-letter" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-6750dfda-2a1d-4623-bb81-b7c7ef628b59" }, { "id": "cf920a53-8dca-485c-a27e-a089dd6247b6", "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/resignations/:offboarding_request_id/resignation-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "resignation-letter" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-cf920a53-8dca-485c-a27e-a089dd6247b6" }, { "id": "c3671b25-bcb8-46e6-872f-be05d2c421de", "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/resignations/:offboarding_request_id/resignation-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "resignation-letter" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-c3671b25-bcb8-46e6-872f-be05d2c421de" }, { "id": "2f9c13eb-cc13-4a68-9055-0948779898ca", "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/resignations/:offboarding_request_id/resignation-letter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "resignation-letter" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-2f9c13eb-cc13-4a68-9055-0948779898ca" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-eb44b4b7-a5c8-44ba-955d-4e6c6fcebc2b" } ], "id": "0d6aef7f-a7d1-4b8c-9729-3bf62de9543f", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-0d6aef7f-a7d1-4b8c-9729-3bf62de9543f" }, { "name": "validate", "item": [ { "name": "Validate resignation request", "id": "398a3874-a83a-41dc-b8e7-7a7c0186923c", "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 \"accepts_proposed_notice\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_resignation_reason\": \"\",\n \"has_additional_information\": \"\",\n \"has_more_salary_info\": \"\",\n \"is_owed_outstanding_reimbursements\": \"\",\n \"will_take_more_pto\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"agrees_to_resignation_reason_notes\": \"\",\n \"has_additional_information_notes\": \"\",\n \"has_more_salary_info_notes\": \"\",\n \"owed_outstanding_reimbursements\": {\n \"amount\": \"\",\n \"notes\": \"\"\n },\n \"proposed_last_date\": {\n \"date\": \"\",\n \"notes\": \"\"\n },\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_take_more_pto_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/validate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "validate" ], "variable": [ { "id": "71fec376-6aa5-417f-9088-b54155314722", "key": "offboarding_request_id", "value": "", "description": "(Required) Offboarding request ID" } ] }, "description": "Validates a resignation employment request\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | - | Manage resignations (`resignation:write`) |\n" }, "response": [ { "id": "b0193914-d32b-413f-bfcf-2e3229be8e81", "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 \"accepts_proposed_notice\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_resignation_reason\": \"\",\n \"has_additional_information\": \"\",\n \"has_more_salary_info\": \"\",\n \"is_owed_outstanding_reimbursements\": \"\",\n \"will_take_more_pto\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"agrees_to_resignation_reason_notes\": \"\",\n \"has_additional_information_notes\": \"\",\n \"has_more_salary_info_notes\": \"\",\n \"owed_outstanding_reimbursements\": {\n \"amount\": \"\",\n \"notes\": \"\"\n },\n \"proposed_last_date\": {\n \"date\": \"\",\n \"notes\": \"\"\n },\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_take_more_pto_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/validate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "validate" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-b0193914-d32b-413f-bfcf-2e3229be8e81" }, { "id": "90384120-5a99-4064-9c50-6da3cfe14bc5", "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 \"accepts_proposed_notice\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_resignation_reason\": \"\",\n \"has_additional_information\": \"\",\n \"has_more_salary_info\": \"\",\n \"is_owed_outstanding_reimbursements\": \"\",\n \"will_take_more_pto\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"agrees_to_resignation_reason_notes\": \"\",\n \"has_additional_information_notes\": \"\",\n \"has_more_salary_info_notes\": \"\",\n \"owed_outstanding_reimbursements\": {\n \"amount\": \"\",\n \"notes\": \"\"\n },\n \"proposed_last_date\": {\n \"date\": \"\",\n \"notes\": \"\"\n },\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_take_more_pto_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/validate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "validate" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-90384120-5a99-4064-9c50-6da3cfe14bc5" }, { "id": "954322da-3ce2-4979-8cbc-c9b53dbab638", "name": "Unauthorized", "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 \"accepts_proposed_notice\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_resignation_reason\": \"\",\n \"has_additional_information\": \"\",\n \"has_more_salary_info\": \"\",\n \"is_owed_outstanding_reimbursements\": \"\",\n \"will_take_more_pto\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"agrees_to_resignation_reason_notes\": \"\",\n \"has_additional_information_notes\": \"\",\n \"has_more_salary_info_notes\": \"\",\n \"owed_outstanding_reimbursements\": {\n \"amount\": \"\",\n \"notes\": \"\"\n },\n \"proposed_last_date\": {\n \"date\": \"\",\n \"notes\": \"\"\n },\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_take_more_pto_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/validate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "validate" ], "variable": [ { "key": "offboarding_request_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-954322da-3ce2-4979-8cbc-c9b53dbab638" }, { "id": "6bdcd8f4-ba58-4eb5-aaf8-f9095bfc0340", "name": "Not Found", "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 \"accepts_proposed_notice\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_resignation_reason\": \"\",\n \"has_additional_information\": \"\",\n \"has_more_salary_info\": \"\",\n \"is_owed_outstanding_reimbursements\": \"\",\n \"will_take_more_pto\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"agrees_to_resignation_reason_notes\": \"\",\n \"has_additional_information_notes\": \"\",\n \"has_more_salary_info_notes\": \"\",\n \"owed_outstanding_reimbursements\": {\n \"amount\": \"\",\n \"notes\": \"\"\n },\n \"proposed_last_date\": {\n \"date\": \"\",\n \"notes\": \"\"\n },\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_take_more_pto_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/validate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "validate" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-6bdcd8f4-ba58-4eb5-aaf8-f9095bfc0340" }, { "id": "9e89e54c-7ecf-48e3-a305-152616cda57c", "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 \"accepts_proposed_notice\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_resignation_reason\": \"\",\n \"has_additional_information\": \"\",\n \"has_more_salary_info\": \"\",\n \"is_owed_outstanding_reimbursements\": \"\",\n \"will_take_more_pto\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"agrees_to_resignation_reason_notes\": \"\",\n \"has_additional_information_notes\": \"\",\n \"has_more_salary_info_notes\": \"\",\n \"owed_outstanding_reimbursements\": {\n \"amount\": \"\",\n \"notes\": \"\"\n },\n \"proposed_last_date\": {\n \"date\": \"\",\n \"notes\": \"\"\n },\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_take_more_pto_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/validate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "validate" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-9e89e54c-7ecf-48e3-a305-152616cda57c" }, { "id": "19643f53-8f5c-4f8f-9c4e-6b5087bee784", "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 \"accepts_proposed_notice\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"agrees_to_resignation_reason\": \"\",\n \"has_additional_information\": \"\",\n \"has_more_salary_info\": \"\",\n \"is_owed_outstanding_reimbursements\": \"\",\n \"will_take_more_pto\": \"\",\n \"agrees_to_pto_amount_notes\": \"\",\n \"agrees_to_resignation_reason_notes\": \"\",\n \"has_additional_information_notes\": \"\",\n \"has_more_salary_info_notes\": \"\",\n \"owed_outstanding_reimbursements\": {\n \"amount\": \"\",\n \"notes\": \"\"\n },\n \"proposed_last_date\": {\n \"date\": \"\",\n \"notes\": \"\"\n },\n \"timesheet_file\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"will_take_more_pto_notes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id/validate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id", "validate" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-19643f53-8f5c-4f8f-9c4e-6b5087bee784" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-398a3874-a83a-41dc-b8e7-7a7c0186923c" } ], "id": "c864a566-d02c-475e-a7ee-ccb9a862a201", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-c864a566-d02c-475e-a7ee-ccb9a862a201" }, { "name": "Show Resignation", "id": "38fe7ccc-3f8d-4565-ab9d-7070be7a2009", "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/resignations/:offboarding_request_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id" ], "variable": [ { "id": "3d78e2b4-0664-4c84-9bec-238d6f245a83", "key": "offboarding_request_id", "value": "", "description": "(Required) Offboarding request ID" } ] }, "description": "Shows the details of a resignation with status `submitted`.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View resignations (`resignation:read`) | Manage resignations (`resignation:write`) |\n" }, "response": [ { "id": "87878aa8-31ae-4b0c-a4f1-3e0a1ccbf81d", "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/resignations/:offboarding_request_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id" ], "variable": [ { "key": "offboarding_request_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"resignation\": {\n \"contract_job_title\": \"\",\n \"contract_start_date\": \"\",\n \"resignation_date\": \"\",\n \"resignation_reason_label\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-87878aa8-31ae-4b0c-a4f1-3e0a1ccbf81d" }, { "id": "63da987b-011d-4e2b-a8e7-427f15a758e2", "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/resignations/:offboarding_request_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-63da987b-011d-4e2b-a8e7-427f15a758e2" }, { "id": "2b01bc79-8acc-4e4e-9f87-75e4bc72baaf", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/resignations/:offboarding_request_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id" ], "variable": [ { "key": "offboarding_request_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-2b01bc79-8acc-4e4e-9f87-75e4bc72baaf" }, { "id": "d87cf99c-3aea-40d3-8865-18bc9efd1676", "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/resignations/:offboarding_request_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-d87cf99c-3aea-40d3-8865-18bc9efd1676" }, { "id": "b5a62df6-3543-415a-8407-5bd06c7dbd61", "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/resignations/:offboarding_request_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-b5a62df6-3543-415a-8407-5bd06c7dbd61" }, { "id": "bb77caff-2fdd-4b98-a5a7-6ccc65661d2c", "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/resignations/:offboarding_request_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "resignations", ":offboarding_request_id" ], "variable": [ { "key": "offboarding_request_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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-bb77caff-2fdd-4b98-a5a7-6ccc65661d2c" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-38fe7ccc-3f8d-4565-ab9d-7070be7a2009" } ], "id": "47ba4170-36cd-4bfa-8ec2-9308dd8c459e", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-47ba4170-36cd-4bfa-8ec2-9308dd8c459e" } ], "id": "ff79830b-80cb-4ce3-9296-14114c178198", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-ff79830b-80cb-4ce3-9296-14114c178198" }, { "name": "travel-letter-requests", "item": [ { "name": "{id}", "item": [ { "name": "Show travel letter request", "id": "4093ef25-2102-4b58-a7a7-63371033c22a", "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/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "id": "c8ec5a5a-3e84-4553-88fa-7012cd7e97e0", "key": "id", "value": "", "description": "(Required) travel letter request ID" } ] }, "description": "Show a single travel letter request.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View travel letters (`travel_letter:read`) | Manage travel letters (`travel_letter:write`) |\n" }, "response": [ { "id": "04feb6ff-8100-40c8-a1ce-cf4cddfe8a45", "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/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"travel_letter_request\": {\n \"additional_information\": \"\",\n \"destination_country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"embassy_address\": \"\",\n \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"requires_travel_address\": \"\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"responsible_for_travel_cost\": \"employer\",\n \"status\": \"declined_by_remote\",\n \"submitted_at\": \"\",\n \"travel_address\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"travel_reason\": \"\",\n \"travel_reason_details\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-04feb6ff-8100-40c8-a1ce-cf4cddfe8a45" }, { "id": "ef500306-b5da-4641-91a7-fbd3bf8c93d6", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-ef500306-b5da-4641-91a7-fbd3bf8c93d6" }, { "id": "231aace7-1644-4d78-92f2-abb890566d26", "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/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-231aace7-1644-4d78-92f2-abb890566d26" }, { "id": "e45b959b-e581-450c-95ed-a75c16a2035f", "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/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-e45b959b-e581-450c-95ed-a75c16a2035f" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-4093ef25-2102-4b58-a7a7-63371033c22a" }, { "name": "Updates a travel letter request", "id": "4175038a-083d-4141-a057-dbf9e179f994", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "id": "9988fef1-92c3-46ed-abe9-cca0aaa4a9b9", "key": "id", "value": "", "description": "(Required) Travel letter Request ID" } ] }, "description": "Updates a travel letter request\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage travel letters (`travel_letter:write`) |\n" }, "response": [ { "id": "685ce545-f248-423a-ace4-918a4da65493", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"travel_letter_request\": {\n \"additional_information\": \"\",\n \"destination_country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"embassy_address\": \"\",\n \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"requires_travel_address\": \"\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"responsible_for_travel_cost\": \"employer\",\n \"status\": \"declined_by_remote\",\n \"submitted_at\": \"\",\n \"travel_address\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"travel_reason\": \"\",\n \"travel_reason_details\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-685ce545-f248-423a-ace4-918a4da65493" }, { "id": "b3a894de-6954-4df3-afa9-cf1dd2100cf4", "name": "Unauthorized", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-b3a894de-6954-4df3-afa9-cf1dd2100cf4" }, { "id": "9a997693-7f7e-4f8d-8392-47f3e778130d", "name": "Not Found", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-9a997693-7f7e-4f8d-8392-47f3e778130d" }, { "id": "0b3c8b96-4c83-4284-b748-dad651adfe1f", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-0b3c8b96-4c83-4284-b748-dad651adfe1f" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-4175038a-083d-4141-a057-dbf9e179f994" }, { "name": "Updates a travel letter request", "id": "5fe9c663-6c99-4dbb-92d8-378c68a56806", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "id": "d4126110-780b-4e5f-8f32-1866186e8122", "key": "id", "value": "", "description": "(Required) Travel letter Request ID" } ] }, "description": "Updates a travel letter request\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | - | Manage travel letters (`travel_letter:write`) |\n" }, "response": [ { "id": "6f5d0061-62c5-4b95-af99-8e2685b02b71", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"travel_letter_request\": {\n \"additional_information\": \"\",\n \"destination_country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"embassy_address\": \"\",\n \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"requires_travel_address\": \"\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"responsible_for_travel_cost\": \"employer\",\n \"status\": \"declined_by_remote\",\n \"submitted_at\": \"\",\n \"travel_address\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"travel_reason\": \"\",\n \"travel_reason_details\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-6f5d0061-62c5-4b95-af99-8e2685b02b71" }, { "id": "75936713-dcde-4dcd-8aa8-7e8222606e7b", "name": "Unauthorized", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-75936713-dcde-4dcd-8aa8-7e8222606e7b" }, { "id": "0de8d10e-a7c3-4d61-ac15-5f357bd4e3ac", "name": "Not Found", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-0de8d10e-a7c3-4d61-ac15-5f357bd4e3ac" }, { "id": "360e7b0b-4faa-422c-9365-be62c16e50f0", "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 \"status\": \"approved_by_manager\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employee\",\n \"employer_special_instructions\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/travel-letter-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-360e7b0b-4faa-422c-9365-be62c16e50f0" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-5fe9c663-6c99-4dbb-92d8-378c68a56806" } ], "id": "c23a65bf-9d83-423b-905a-a563fc5ad3a1", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-c23a65bf-9d83-423b-905a-a563fc5ad3a1" }, { "name": "List travel letter requests", "id": "5cee27c1-bcbe-4b34-ada7-e71a7c3c73e0", "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/travel-letter-requests?status=cancelled&employment_id=&employee_name=&order=desc&sort_by=submitted_at&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests" ], "query": [ { "description": "Filter results on the given status", "key": "status", "value": "cancelled" }, { "description": "Filter results on the given employment slug", "key": "employment_id", "value": "" }, { "description": "Filter results on the given employee name", "key": "employee_name", "value": "" }, { "description": "Sort order", "key": "order", "value": "desc" }, { "description": "Field to sort by", "key": "sort_by", "value": "submitted_at" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "List travel letter requests.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View travel letters (`travel_letter:read`) | Manage travel letters (`travel_letter:write`) |\n" }, "response": [ { "id": "86577046-fb17-4c2d-bc59-c6b2ec54f54d", "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/travel-letter-requests?status=cancelled&employment_id=&employee_name=&order=desc&sort_by=submitted_at&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests" ], "query": [ { "description": "Filter results on the given status", "key": "status", "value": "cancelled" }, { "description": "Filter results on the given employment slug", "key": "employment_id", "value": "" }, { "description": "Filter results on the given employee name", "key": "employee_name", "value": "" }, { "description": "Sort order", "key": "order", "value": "desc" }, { "description": "Field to sort by", "key": "sort_by", "value": "submitted_at" }, { "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 \"total_count\": \"\",\n \"total_pages\": \"\",\n \"travel_letter_requests\": [\n {\n \"additional_information\": \"\",\n \"destination_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 \"embassy_address\": \"\",\n \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"requires_travel_address\": \"\",\n \"responsible_for_accommodation_cost\": \"employee\",\n \"responsible_for_meal_cost\": \"employee\",\n \"responsible_for_travel_cost\": \"employee\",\n \"status\": \"cancelled\",\n \"submitted_at\": \"\",\n \"travel_address\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"travel_reason\": \"\",\n \"travel_reason_details\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"additional_information\": \"\",\n \"destination_country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"standard\",\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 \"embassy_address\": \"\",\n \"employer_approver\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n },\n \"employer_special_instructions\": \"\",\n \"id\": \"\",\n \"reason\": \"\",\n \"requires_travel_address\": \"\",\n \"responsible_for_accommodation_cost\": \"employer\",\n \"responsible_for_meal_cost\": \"employer\",\n \"responsible_for_travel_cost\": \"employee\",\n \"status\": \"approved_by_remote\",\n \"submitted_at\": \"\",\n \"travel_address\": \"\",\n \"travel_date_end\": \"\",\n \"travel_date_start\": \"\",\n \"travel_document_number\": \"\",\n \"travel_reason\": \"\",\n \"travel_reason_details\": \"\",\n \"user\": {\n \"email\": \"\",\n \"name\": \"\",\n \"id\": \"\"\n }\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-86577046-fb17-4c2d-bc59-c6b2ec54f54d" }, { "id": "2b216c4e-3451-48b0-9e2b-4b91c53d138e", "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/travel-letter-requests?status=cancelled&employment_id=&employee_name=&order=desc&sort_by=submitted_at&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests" ], "query": [ { "description": "Filter results on the given status", "key": "status", "value": "cancelled" }, { "description": "Filter results on the given employment slug", "key": "employment_id", "value": "" }, { "description": "Filter results on the given employee name", "key": "employee_name", "value": "" }, { "description": "Sort order", "key": "order", "value": "desc" }, { "description": "Field to sort by", "key": "sort_by", "value": "submitted_at" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-2b216c4e-3451-48b0-9e2b-4b91c53d138e" }, { "id": "493724ef-1c4b-4186-a7a2-f6537bdec8b6", "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/travel-letter-requests?status=cancelled&employment_id=&employee_name=&order=desc&sort_by=submitted_at&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "travel-letter-requests" ], "query": [ { "description": "Filter results on the given status", "key": "status", "value": "cancelled" }, { "description": "Filter results on the given employment slug", "key": "employment_id", "value": "" }, { "description": "Filter results on the given employee name", "key": "employee_name", "value": "" }, { "description": "Sort order", "key": "order", "value": "desc" }, { "description": "Field to sort by", "key": "sort_by", "value": "submitted_at" }, { "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-493724ef-1c4b-4186-a7a2-f6537bdec8b6" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-5cee27c1-bcbe-4b34-ada7-e71a7c3c73e0" } ], "id": "b4089b92-45fe-4f9a-814f-0e904ddae06b", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-b4089b92-45fe-4f9a-814f-0e904ddae06b" } ], "id": "cb8ce472-9ee6-4aa2-bcf6-e3332b9cd4de", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-cb8ce472-9ee6-4aa2-bcf6-e3332b9cd4de" }, { "name": "v2", "item": [ { "name": "offboardings", "item": [ { "name": "{id}", "item": [ { "name": "Show Offboarding (v2)", "id": "defef6d6-242b-42f9-9e05-5f1041a734bd", "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}}/v2/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings", ":id" ], "variable": [ { "id": "c8257f5a-3cfb-4e35-a8f8-10deb25e0844", "key": "id", "value": "", "description": "(Required) Offboarding ID" } ] }, "description": "Returns a single offboarding by its ID.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |\n" }, "response": [ { "id": "7a5e1e03-24d6-4a74-806c-0498dbb37b8b", "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}}/v2/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"offboarding\": {\n \"id\": \"\",\n \"status\": \"in_review\",\n \"type\": \"conversion\",\n \"employment_id\": \"\",\n \"inserted_at\": \"\",\n \"confidential\": \"\",\n \"reason\": \"\",\n \"request\": {\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"proposed_termination_date\": \"\",\n \"reason_description\": \"\",\n \"risk_assessment_reasons\": [\n \"\",\n \"\"\n ],\n \"will_challenge_termination\": \"\",\n \"will_challenge_termination_description\": \"\"\n },\n \"termination_date\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-7a5e1e03-24d6-4a74-806c-0498dbb37b8b" }, { "id": "414b22e4-a444-492e-a6e4-1b3fb540ec62", "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}}/v2/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings", ":id" ], "variable": [ { "key": "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-414b22e4-a444-492e-a6e4-1b3fb540ec62" }, { "id": "f8c45a37-3f7f-41be-9f75-059d19e8a9d1", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-f8c45a37-3f7f-41be-9f75-059d19e8a9d1" }, { "id": "2124efe9-e1b0-461c-acea-bb4aaae165d0", "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}}/v2/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-2124efe9-e1b0-461c-acea-bb4aaae165d0" }, { "id": "c6a606c9-226c-4f75-8366-c1894a60139f", "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}}/v2/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-c6a606c9-226c-4f75-8366-c1894a60139f" }, { "id": "8ce32197-a146-472b-9e2c-bcaba4896305", "name": "Too many requests", "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}}/v2/offboardings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings", ":id" ], "variable": [ { "key": "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-8ce32197-a146-472b-9e2c-bcaba4896305" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-defef6d6-242b-42f9-9e05-5f1041a734bd" } ], "id": "b4b9d71d-4bba-4628-ba92-a981b0d09d78", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-b4b9d71d-4bba-4628-ba92-a981b0d09d78" }, { "name": "List Offboardings (v2)", "id": "65305af4-a5ee-4e1a-82df-6d3d5930acf5", "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}}/v2/offboardings?employment_id=&type=transfer&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type.", "key": "type", "value": "transfer" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] }, "description": "Lists offboardings for a company.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |\n" }, "response": [ { "id": "ed5e64e7-5d89-4fcb-94af-651c8bfd7ee3", "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}}/v2/offboardings?employment_id=&type=transfer&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type.", "key": "type", "value": "transfer" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"offboardings\": [\n {\n \"id\": \"\",\n \"status\": \"pending_payment\",\n \"type\": \"transfer\",\n \"employment_id\": \"\",\n \"inserted_at\": \"\",\n \"confidential\": \"\",\n \"reason\": \"\",\n \"request\": {\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"proposed_termination_date\": \"\",\n \"reason_description\": \"\",\n \"risk_assessment_reasons\": [\n \"\",\n \"\"\n ],\n \"will_challenge_termination\": \"\",\n \"will_challenge_termination_description\": \"\"\n },\n \"termination_date\": \"\"\n },\n {\n \"id\": \"\",\n \"status\": \"in_review\",\n \"type\": \"resignation\",\n \"employment_id\": \"\",\n \"inserted_at\": \"\",\n \"confidential\": \"\",\n \"reason\": \"\",\n \"request\": {\n \"additional_comments\": \"\",\n \"agrees_to_pto_amount\": \"\",\n \"employee_awareness\": {\n \"date\": \"\",\n \"note\": \"\"\n },\n \"proposed_termination_date\": \"\",\n \"reason_description\": \"\",\n \"risk_assessment_reasons\": [\n \"\",\n \"\"\n ],\n \"will_challenge_termination\": \"\",\n \"will_challenge_termination_description\": \"\"\n },\n \"termination_date\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-ed5e64e7-5d89-4fcb-94af-651c8bfd7ee3" }, { "id": "8cc128c1-dc09-45e3-a6be-36b63e496934", "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}}/v2/offboardings?employment_id=&type=transfer&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type.", "key": "type", "value": "transfer" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-8cc128c1-dc09-45e3-a6be-36b63e496934" }, { "id": "4a04ffb3-e37f-45b9-8ce1-4ec82b5df5f5", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v2/offboardings?employment_id=&type=transfer&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type.", "key": "type", "value": "transfer" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-4a04ffb3-e37f-45b9-8ce1-4ec82b5df5f5" }, { "id": "7e332640-a7a1-4842-9fa8-10873b9d62ab", "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}}/v2/offboardings?employment_id=&type=transfer&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type.", "key": "type", "value": "transfer" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-7e332640-a7a1-4842-9fa8-10873b9d62ab" }, { "id": "46ad04b9-d688-41cc-a5f7-1bf859390155", "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}}/v2/offboardings?employment_id=&type=transfer&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type.", "key": "type", "value": "transfer" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-46ad04b9-d688-41cc-a5f7-1bf859390155" }, { "id": "3782ead2-b37c-4b8e-aac2-5f929105ede6", "name": "Too many requests", "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}}/v2/offboardings?employment_id=&type=transfer&include_confidential=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "offboardings" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by offboarding type.", "key": "type", "value": "transfer" }, { "description": "By default, the results do not include confidential termination requests.\nSend `include_confidential=true` to include confidential requests in the response.\n", "key": "include_confidential", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "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:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-3782ead2-b37c-4b8e-aac2-5f929105ede6" } ], "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-65305af4-a5ee-4e1a-82df-6d3d5930acf5" } ], "id": "33c58f98-d555-4c6f-bdf9-b1a9f21ef982", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-33c58f98-d555-4c6f-bdf9-b1a9f21ef982" } ], "id": "0b33de39-524f-4593-bb14-8225d2045d03", "createdAt": "2026-07-28T02:46:50.000Z", "updatedAt": "2026-07-28T02:46:50.000Z", "uid": "35240-0b33de39-524f-4593-bb14-8225d2045d03" } ], "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/" } ] }