{ "info": { "_postman_id": "40fc01d7-624c-4856-96b4-c390ca4fa92a", "name": "Remote Address Details Companies API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:45:05.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "lastUpdatedBy": "35240", "uid": "35240-40fc01d7-624c-4856-96b4-c390ca4fa92a" }, "item": [ { "name": "v1", "item": [ { "name": "companies", "item": [ { "name": "{company_id}", "item": [ { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "onboarding-reserves-status", "item": [ { "name": "Get Onboarding Reserves Status for Employment", "id": "40e34500-7ddd-455c-9ada-341d694b58f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "id": "15c0666d-313e-46df-8dc0-7096a5444e79", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "eb799510-71a9-481f-87c3-ae056ef13f9b", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Returns the onboarding reserves status for a specific employment.\n\nThe status is the same as the credit risk status but takes the onboarding reserves policies into account.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |\n" }, "response": [ { "id": "66263db1-50a1-4faf-8f73-43d18374ca56", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "key": "company_id" }, { "key": "employment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"no_deposit_required\",\n \"policies\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-66263db1-50a1-4faf-8f73-43d18374ca56" }, { "id": "7c822765-ae8c-4804-9927-4a02b0fef3d8", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "key": "company_id" }, { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-7c822765-ae8c-4804-9927-4a02b0fef3d8" }, { "id": "3369f233-7660-41e7-9e4f-dd2abdc53d1e", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "key": "company_id" }, { "key": "employment_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-3369f233-7660-41e7-9e4f-dd2abdc53d1e" }, { "id": "e889d1db-d346-4fb3-a23a-66d583438733", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/employments/:employment_id/onboarding-reserves-status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "employments", ":employment_id", "onboarding-reserves-status" ], "variable": [ { "key": "company_id" }, { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-e889d1db-d346-4fb3-a23a-66d583438733" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-40e34500-7ddd-455c-9ada-341d694b58f5" } ], "id": "1dab3ac7-fa62-4288-856a-0487a03dc5c6", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-1dab3ac7-fa62-4288-856a-0487a03dc5c6" } ], "id": "99b0e257-0735-42e5-a1ed-c4617a060ccc", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-99b0e257-0735-42e5-a1ed-c4617a060ccc" } ], "id": "5f7f68be-3f7a-4b0a-ac60-a8142817239d", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-5f7f68be-3f7a-4b0a-ac60-a8142817239d" }, { "name": "compliance-profile", "item": [ { "name": "Get Company Compliance Profile", "id": "4a91e7fd-04fb-4f50-9b21-861449844334", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "id": "0985a2b1-cdb9-4c50-be6d-e70a7beab484", "key": "company_id", "value": "", "description": "(Required) Company ID" } ] }, "description": "Returns the KYB and credit risk status for the company's default legal entity.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "3b9cd3ab-5c81-454b-9c0e-3e3be6ebe520", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "key": "company_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"compliance_profile\": {\n \"kyb_status\": \"pass\",\n \"credit_risk_status\": \"in_progress\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-3b9cd3ab-5c81-454b-9c0e-3e3be6ebe520" }, { "id": "30521e03-b685-483a-a024-ce1d9636e0f7", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-30521e03-b685-483a-a024-ce1d9636e0f7" }, { "id": "5d59cb77-551d-47b2-8cf6-530539919699", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "key": "company_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-5d59cb77-551d-47b2-8cf6-530539919699" }, { "id": "a69e050d-bf9e-410d-bd12-2c288dd411b7", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/compliance-profile", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "compliance-profile" ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-a69e050d-bf9e-410d-bd12-2c288dd411b7" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-4a91e7fd-04fb-4f50-9b21-861449844334" } ], "id": "60de5cb1-9fc6-4cce-8fab-1f0e4a305dcc", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-60de5cb1-9fc6-4cce-8fab-1f0e4a305dcc" }, { "name": "legal-entities", "item": [ { "name": "{legal_entity_id}", "item": [ { "name": "administrative-details", "item": [ { "name": "Show Legal Entity Administrative details", "id": "189741d6-3f21-4e98-a9d5-92f321c034e2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "id": "d8102e61-50bf-4c38-a03f-9993edfda755", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "26f2eff9-73d9-40bc-9b3d-bc54da2c3a53", "key": "legal_entity_id", "value": "", "description": "(Required) Legal entity ID" } ] }, "description": "Show administrative details of legal entity for the authorized company specified in the request.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "ed45bf44-a9c5-4df2-812a-d960ff3c07ab", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-ed45bf44-a9c5-4df2-812a-d960ff3c07ab" }, { "id": "0414fd2b-7e6a-4227-8181-e616d6bec512", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-0414fd2b-7e6a-4227-8181-e616d6bec512" }, { "id": "dca2dbba-3f75-4ec7-9885-5216f1a12b3b", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-dca2dbba-3f75-4ec7-9885-5216f1a12b3b" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-189741d6-3f21-4e98-a9d5-92f321c034e2" }, { "name": "Update Legal Entity Administrative details", "id": "6de26651-27cc-4dfb-9b96-eb49f003b73f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"product_type\": \"global_payroll\",\n \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "id": "6d161ddb-734d-4da0-9086-8dd59b46ad76", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "f2375f4a-0fa0-4f34-8c3f-0a6c9ac84cf7", "key": "legal_entity_id", "value": "", "description": "(Required) Legal entity ID" } ] }, "description": "Update administrative details of legal entity for the authorized company specified in the request.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage companies (`company_management`) | - | Manage companies (`company:write`) |\n" }, "response": [ { "id": "528fb019-64b7-4303-a8fe-f539e129aa77", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"product_type\": \"global_payroll\",\n \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-528fb019-64b7-4303-a8fe-f539e129aa77" }, { "id": "9f28200d-9680-457e-b564-d18d2ed0e448", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"product_type\": \"global_payroll\",\n \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-9f28200d-9680-457e-b564-d18d2ed0e448" }, { "id": "a85f9e1c-b871-4179-a69a-7ef7e6be25a3", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"product_type\": \"global_payroll\",\n \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-a85f9e1c-b871-4179-a69a-7ef7e6be25a3" }, { "id": "605bd412-53ac-4d3d-8adc-b8347bf3b071", "name": "Conflict", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"product_type\": \"global_payroll\",\n \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-605bd412-53ac-4d3d-8adc-b8347bf3b071" }, { "id": "7040e950-4674-4835-b4c1-97b4e44067a9", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"product_type\": \"global_payroll\",\n \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-7040e950-4674-4835-b4c1-97b4e44067a9" }, { "id": "95441c64-2e6d-4efe-a171-17b0498f6279", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"product_type\": \"global_payroll\",\n \"administrative_details\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/administrative-details", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "administrative-details" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-95441c64-2e6d-4efe-a171-17b0498f6279" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-6de26651-27cc-4dfb-9b96-eb49f003b73f" } ], "id": "25a46135-e5be-4d8f-8f71-d82b0a93a3d7", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-25a46135-e5be-4d8f-8f71-d82b0a93a3d7" }, { "name": "contractor-eligibility", "item": [ { "name": "Show contractor eligibility and COR-supported countries for legal entity", "id": "2d78d1f6-65ef-475a-8eff-d29d3e9875db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/contractor-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "contractor-eligibility" ], "variable": [ { "id": "482dfb1a-abfb-45d8-89a2-7b5124bca373", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "453035d5-b4de-420b-88fa-ff753c319f55", "key": "legal_entity_id", "value": "", "description": "(Required) Legal entity ID" } ] }, "description": "Returns which contractor products (standard, plus, cor) the legal entity is eligible to use,\nand the list of country codes where COR is supported for this legal entity.\nCOR-supported countries exclude sanctioned and signup-prevented countries and apply entity rules (same-country, local-to-local).\nWhen the legal entity is not COR-eligible, `cor_supported_country_codes` is an empty list.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "46882685-0ddd-4b6b-9ca5-f6699704d569", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/contractor-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "contractor-eligibility" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"contractor_eligibility\": {\n \"standard\": \"\",\n \"plus\": \"\",\n \"cor\": \"\",\n \"ineligibility_reasons\": {\n \"standard\": [\n \"\",\n \"\"\n ],\n \"plus\": [\n \"\",\n \"\"\n ],\n \"cor\": [\n \"\",\n \"\"\n ]\n }\n },\n \"cor_supported_country_codes\": [\n \"\",\n \"\"\n ]\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-46882685-0ddd-4b6b-9ca5-f6699704d569" }, { "id": "534c5b01-cc3a-4470-86ff-4e2a8826cfb1", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/contractor-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "contractor-eligibility" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-534c5b01-cc3a-4470-86ff-4e2a8826cfb1" }, { "id": "f0842a9e-f744-46c2-b996-94a5b88b1308", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/contractor-eligibility", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "contractor-eligibility" ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f0842a9e-f744-46c2-b996-94a5b88b1308" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-2d78d1f6-65ef-475a-8eff-d29d3e9875db" } ], "id": "6fbc1657-f470-40a9-a7e3-584a62d230bf", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-6fbc1657-f470-40a9-a7e3-584a62d230bf" } ], "id": "ad7fa3d5-b6f5-42c3-90e9-6a32439e5be5", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-ad7fa3d5-b6f5-42c3-90e9-6a32439e5be5" }, { "name": "List Company Legal Entities", "id": "ceee9bb6-95c8-4ec3-8dba-98deb220a290", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "b2176cd5-1448-4b36-a0b9-5109be48f39c", "key": "company_id", "value": "", "description": "(Required) Company ID" } ] }, "description": "Lists all active legal entities for the authorized company specified in the request.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "8027a4ea-86a7-4f9b-b259-37974e0402f6", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "company_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 \"legal_entities\": [\n {\n \"id\": \"\",\n \"global_payroll_enabled\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"is_default\": \"\"\n },\n {\n \"id\": \"\",\n \"global_payroll_enabled\": \"\",\n \"name\": \"\",\n \"country_code\": \"\",\n \"is_default\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-8027a4ea-86a7-4f9b-b259-37974e0402f6" }, { "id": "035d7c03-332c-4035-baff-802eff22f3ad", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-035d7c03-332c-4035-baff-802eff22f3ad" }, { "id": "48e1baed-f1ba-4d03-9d1c-a70650e4e352", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-48e1baed-f1ba-4d03-9d1c-a70650e4e352" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-ceee9bb6-95c8-4ec3-8dba-98deb220a290" } ], "id": "0dfe3ea7-49c2-4605-b6b0-cc32606cb596", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-0dfe3ea7-49c2-4605-b6b0-cc32606cb596" }, { "name": "actions", "item": [ { "name": "List a company's pending actions", "id": "7d3ede61-73ff-44f2-9803-dc66eeb9e913", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/actions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "actions" ], "variable": [ { "id": "3abbfdfc-8857-4424-ab37-cf4de15ad8e8", "key": "company_id", "value": "", "description": "(Required) Company ID" } ] }, "description": "Given a company ID, returns the company-level actions still pending for the company \u2014 for\nexample company verification and Remote Payments setup. The list can be empty or contain one\nor more actions; `setup_remote_payments` is returned once per legal entity that needs it.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "c8affaae-5a75-4885-bab5-57b89bb4fc11", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/actions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "actions" ], "variable": [ { "key": "company_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"actions\": [\n {\n \"type\": \"verify_company\",\n \"required\": \"\",\n \"legal_entity_id\": \"\"\n },\n {\n \"type\": \"setup_remote_payments\",\n \"required\": \"\",\n \"legal_entity_id\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-c8affaae-5a75-4885-bab5-57b89bb4fc11" }, { "id": "43eba953-76ca-445c-92cb-eca85cf3c3f9", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/actions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "actions" ], "variable": [ { "key": "company_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-43eba953-76ca-445c-92cb-eca85cf3c3f9" }, { "id": "2bf6f655-de2c-414d-a230-1a6c9b6bcb2d", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/actions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "actions" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-2bf6f655-de2c-414d-a230-1a6c9b6bcb2d" }, { "id": "8007b97d-11d9-41ad-b062-4a02fad75585", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/actions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "actions" ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-8007b97d-11d9-41ad-b062-4a02fad75585" }, { "id": "86a6a1aa-e0f7-4a89-ae3e-ff135731da75", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/actions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "actions" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-86a6a1aa-e0f7-4a89-ae3e-ff135731da75" }, { "id": "f03493b3-0012-4931-8af5-f49a015f751a", "name": "Too many requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/actions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "actions" ], "variable": [ { "key": "company_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f03493b3-0012-4931-8af5-f49a015f751a" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-7d3ede61-73ff-44f2-9803-dc66eeb9e913" } ], "id": "f66bc2d5-bee1-469a-8c5d-0098797d1318", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f66bc2d5-bee1-469a-8c5d-0098797d1318" }, { "name": "Show a company", "id": "8c3d1ad8-23d2-409b-85fd-02860ed8a550", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "variable": [ { "id": "e73224a2-5a96-4e4d-a1ca-42a71064879b", "key": "company_id", "value": "", "description": "(Required) Company ID" } ] }, "description": "Given an ID, shows a company.\n\nIf the used access token was issued by the OAuth 2.0 Authorization Code flow,\nthen only the associated company can be accessed through the endpoint.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "ce6723ed-846c-4458-8d0e-0a7ba7d6eb71", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "variable": [ { "key": "company_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"company\": {\n \"address_details\": {},\n \"company_owner_email\": \"\",\n \"company_owner_user_id\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"desired_currency\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"updated_at\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"default_legal_entity_credit_risk_status\": \"in_progress\",\n \"bank_account_details\": {},\n \"company_owner_name\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-ce6723ed-846c-4458-8d0e-0a7ba7d6eb71" }, { "id": "d5f70ffd-1f03-427d-8284-109ee2163942", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "variable": [ { "key": "company_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-d5f70ffd-1f03-427d-8284-109ee2163942" }, { "id": "7cbe5d2d-e2f6-4069-8734-7a677c573ad9", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-7cbe5d2d-e2f6-4069-8734-7a677c573ad9" }, { "id": "ba271687-21e5-427b-ba11-c2d614bf9089", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-ba271687-21e5-427b-ba11-c2d614bf9089" }, { "id": "e21d7dff-672e-4a07-bcaa-33e2e92c9e8c", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "variable": [ { "key": "company_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-e21d7dff-672e-4a07-bcaa-33e2e92c9e8c" }, { "id": "c93eca9d-6072-4fb1-8856-a9d050edcfb8", "name": "Too many requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "variable": [ { "key": "company_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-c93eca9d-6072-4fb1-8856-a9d050edcfb8" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-8c3d1ad8-23d2-409b-85fd-02860ed8a550" }, { "name": "Update a company", "id": "858a1bfa-e883-401e-82e6-d65c9efc41fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company:read company:write company_admin company_management convert_currency:read country:read employment_documents employment_payments employments help_center_article:read invoices payroll payroll_calendar:read pricing_plan:read pricing_plan:write time_and_attendance webhook:read webhook:write", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "id": "c1be0898-90d5-45b6-9cad-109add1528a2", "key": "company_id", "value": "", "description": "(Required) Company ID\n" } ] }, "description": "Given an ID and a request object with new information, updates a company.\n\n### Getting a company and its owner to `active` status\nIf you created a company using the\n[create a company endpoint](#tag/Companies/operation/post_create_company) without all the required\nrequest body parameters, you can use this endpoint to provide the missing data. Once the company\nand its owner have all the necessary data, both their statuses will be set to `active` and the company\nonboarding will be marked as \"completed\".\n\nThe following constitutes a company with \"all the necessary data\":\n* Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the\n[show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters\nare required).\n* Company `tax_number` or `registration_number` is not nil\n* Company `name` is not nil (already required when creating the company)\n* Company has a `desired_currency` in their bank account (already required when creating the company)\n* Company has accepted terms of service (already required when creating the company)\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage companies (`company_management`) | - | Manage companies (`company:write`) |\n" }, "response": [ { "id": "57b10f49-ced1-4bbc-a593-a287b283ec72", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"company\": {\n \"address_details\": {},\n \"company_owner_email\": \"\",\n \"company_owner_user_id\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"desired_currency\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"updated_at\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"default_legal_entity_credit_risk_status\": \"in_progress\",\n \"bank_account_details\": {},\n \"company_owner_name\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-57b10f49-ced1-4bbc-a593-a287b283ec72" }, { "id": "18f5f828-cf60-4402-b0ea-3beff41e5569", "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-18f5f828-cf60-4402-b0ea-3beff41e5569" }, { "id": "e7296d73-2cba-4237-a86e-ce3aed7bf209", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-e7296d73-2cba-4237-a86e-ce3aed7bf209" }, { "id": "6d640e32-7515-402d-bbe9-3eed1515be8e", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-6d640e32-7515-402d-bbe9-3eed1515be8e" }, { "id": "ec512f0f-9d31-4ec7-a2a0-ac4c6125186c", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-ec512f0f-9d31-4ec7-a2a0-ac4c6125186c" }, { "id": "694f012e-e025-4d19-ad03-bbc7da8db049", "name": "Too many requests", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-694f012e-e025-4d19-ad03-bbc7da8db049" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-858a1bfa-e883-401e-82e6-d65c9efc41fa" }, { "name": "Update a company", "id": "583f90de-dbb2-46a4-a15b-0ea0c1bd080b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company:read company:write company_admin company_management convert_currency:read country:read employment_documents employment_payments employments help_center_article:read invoices payroll payroll_calendar:read pricing_plan:read pricing_plan:write time_and_attendance webhook:read webhook:write", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "id": "92ecea0f-1913-4f51-90aa-7afa90adfc5b", "key": "company_id", "value": "", "description": "(Required) Company ID\n" } ] }, "description": "Given an ID and a request object with new information, updates a company.\n\n### Getting a company and its owner to `active` status\nIf you created a company using the\n[create a company endpoint](#tag/Companies/operation/post_create_company) without all the required\nrequest body parameters, you can use this endpoint to provide the missing data. Once the company\nand its owner have all the necessary data, both their statuses will be set to `active` and the company\nonboarding will be marked as \"completed\".\n\nThe following constitutes a company with \"all the necessary data\":\n* Complete `address`, with valid `address`, `postal_code`, `country` and `state` parameters (Varies by country. Use the\n[show form schema endpoint](#tag/Countries/operation/get_show_form_country) to see which address parameters\nare required).\n* Company `tax_number` or `registration_number` is not nil\n* Company `name` is not nil (already required when creating the company)\n* Company has a `desired_currency` in their bank account (already required when creating the company)\n* Company has accepted terms of service (already required when creating the company)\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage companies (`company_management`) | - | Manage companies (`company:write`) |\n" }, "response": [ { "id": "f403e079-b1ac-4a03-8d0e-e6adbcdea041", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"company\": {\n \"address_details\": {},\n \"company_owner_email\": \"\",\n \"company_owner_user_id\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"desired_currency\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"updated_at\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"default_legal_entity_credit_risk_status\": \"in_progress\",\n \"bank_account_details\": {},\n \"company_owner_name\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f403e079-b1ac-4a03-8d0e-e6adbcdea041" }, { "id": "1e84e200-13b1-4646-8a2c-047d26c65b00", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-1e84e200-13b1-4646-8a2c-047d26c65b00" }, { "id": "ca6b62d6-95c6-40c8-bb93-09ef9b305a2e", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-ca6b62d6-95c6-40c8-bb93-09ef9b305a2e" }, { "id": "728d917d-1c6e-4a6b-b2d8-b082757defc5", "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: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-728d917d-1c6e-4a6b-b2d8-b082757defc5" }, { "id": "a53e7f74-46a6-42b2-a3bb-93ea8aba6d0f", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-a53e7f74-46a6-42b2-a3bb-93ea8aba6d0f" }, { "id": "27a90369-af16-4ad3-bab1-43a790aa2a49", "name": "Too many requests", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_details\": {},\n \"bank_account_details\": {},\n \"country_code\": \"\",\n \"desired_currency\": \"DKK\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies/:company_id?address_details_json_schema_version=&bank_account_details_json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" } ], "variable": [ { "key": "company_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-27a90369-af16-4ad3-bab1-43a790aa2a49" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-583f90de-dbb2-46a4-a15b-0ea0c1bd080b" } ], "id": "0dc0d936-f941-4c1a-8371-588c0d163283", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-0dc0d936-f941-4c1a-8371-588c0d163283" }, { "name": "schema", "item": [ { "name": "Show form schema", "id": "b687bd0e-1972-4e5b-8692-0859102891fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company:read company:write company_admin company_management convert_currency:read country:read employment_documents employment_payments employments help_center_article:read invoices payroll payroll_calendar:read pricing_plan:read pricing_plan:write time_and_attendance webhook:read webhook:write", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/schema?country_code=&form=address_details&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", "schema" ], "query": [ { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "(Required) Name of the desired form", "key": "form", "value": "address_details" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] }, "description": "Returns the json schema of the requested company form.\nCurrently only supports the `address_details` form.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "bdaa37ef-ae46-4ff4-b60a-8d82a2fc41a8", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/schema?country_code=&form=address_details&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", "schema" ], "query": [ { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "(Required) Name of the desired form", "key": "form", "value": "address_details" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-bdaa37ef-ae46-4ff4-b60a-8d82a2fc41a8" }, { "id": "f2365d9f-51a1-40d1-a788-831eb09258df", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/schema?country_code=&form=address_details&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", "schema" ], "query": [ { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "(Required) Name of the desired form", "key": "form", "value": "address_details" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f2365d9f-51a1-40d1-a788-831eb09258df" }, { "id": "69536d2e-cdee-4b38-9a50-872d25e43011", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/schema?country_code=&form=address_details&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", "schema" ], "query": [ { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "(Required) Name of the desired form", "key": "form", "value": "address_details" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-69536d2e-cdee-4b38-9a50-872d25e43011" }, { "id": "71b8d591-bdca-415f-8496-0e20ee394b1f", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies/schema?country_code=&form=address_details&json_schema_version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", "schema" ], "query": [ { "description": "(Required) Country code according to ISO 3-digit alphabetic codes.", "key": "country_code", "value": "" }, { "description": "(Required) Name of the desired form", "key": "form", "value": "address_details" }, { "description": "Version of the form schema", "key": "json_schema_version", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-71b8d591-bdca-415f-8496-0e20ee394b1f" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-b687bd0e-1972-4e5b-8692-0859102891fe" } ], "id": "1e33406f-185f-47e2-8dd0-94726f5062b2", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-1e33406f-185f-47e2-8dd0-94726f5062b2" }, { "name": "List all companies", "id": "bc203275-8972-432c-b55a-99c3002e48ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company:read company:write company_admin company_management convert_currency:read country:read employment_documents employment_payments employments help_center_article:read invoices payroll payroll_calendar:read pricing_plan:read pricing_plan:write time_and_attendance webhook:read webhook:write", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies?external_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "External ID", "key": "external_id", "value": "" } ] }, "description": "List all companies that authorized your integration to act on their behalf. In other words, these are all the companies that your integration can manage. Any company that has completed the authorization flow for your integration will be included in the response.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View companies (`company:read`) | Manage companies (`company:write`) |\n" }, "response": [ { "id": "67c83839-fb9a-4c31-b123-b72a1cf251ce", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies?external_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "External ID", "key": "external_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companies\": [\n {\n \"address_details\": {},\n \"company_owner_email\": \"\",\n \"company_owner_user_id\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"desired_currency\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"pending\",\n \"updated_at\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"default_legal_entity_credit_risk_status\": \"deposit_required\",\n \"bank_account_details\": {},\n \"company_owner_name\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n },\n {\n \"address_details\": {},\n \"company_owner_email\": \"\",\n \"company_owner_user_id\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"desired_currency\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"review\",\n \"updated_at\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"default_legal_entity_credit_risk_status\": \"referred\",\n \"bank_account_details\": {},\n \"company_owner_name\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-67c83839-fb9a-4c31-b123-b72a1cf251ce" }, { "id": "95fd1c7e-90d2-4349-abfe-139f4f799fa2", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies?external_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "External ID", "key": "external_id", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-95fd1c7e-90d2-4349-abfe-139f4f799fa2" }, { "id": "13e5b026-0294-4909-91ae-e4e82011c014", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies?external_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "External ID", "key": "external_id", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-13e5b026-0294-4909-91ae-e4e82011c014" }, { "id": "61dfa87d-1404-4b09-b73c-2b852e6addaf", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/companies?external_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "External ID", "key": "external_id", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-61dfa87d-1404-4b09-b73c-2b852e6addaf" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-bc203275-8972-432c-b55a-99c3002e48ce" }, { "name": "Create a company", "id": "d7baa894-d368-42b6-89d2-c6b21dfc9a0c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company:read company:write company_admin company_management convert_currency:read country:read employment_documents employment_payments employments help_center_article:read invoices payroll payroll_calendar:read pricing_plan:read pricing_plan:write time_and_attendance webhook:read webhook:write", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"company_owner_email\": \"\",\n \"company_owner_name\": \"\",\n \"country_code\": \"\",\n \"desired_currency\": \"GBP\",\n \"name\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"address_details\": {},\n \"bank_account_details\": {},\n \"email_domain\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies?address_details_json_schema_version=&bank_account_details_json_schema_version=&action=&async=&scope=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Complementary action(s) to perform when creating a company:\n\n- `get_oauth_access_tokens` returns the user's access and refresh tokens\n- `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only)\n\nIf `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send)\n", "key": "action", "value": "" }, { "description": "Whether the request should be performed async\n", "key": "async", "value": "" }, { "description": "Scope of the access token\n", "key": "scope", "value": "" } ] }, "description": " Creates a new company.\n\n ### Creating a company with only the required request body parameters\n When you call this endpoint and omit all the optional parameters in the request body,\n the following resources get created upon a successful response:\n * A new company with status `pending`.\n * A company owner for the new company with status `initiated`.\n\n See the [update a company endpoint](#tag/Companies/operation/patch_update_company) for\n more details on how to get your company and its owner to `active` status.\n\n If you'd like to create a company and its owner with `active` status in a single request,\n please provide the optional `address_details` parameter as well.\n\n ### Accepting the Terms of Service\n\n A required step for creating a company in Remote is to accept our Terms of Service (ToS).\n\n Company managers need to be aware of our Terms of Service and Privacy Policy,\n hence **it's the responsibility of our partners to advise and ensure company managers read\n and accept the ToS**. The terms have to be accepted only once, before creating a company,\n and the Remote API will collect the acceptance timestamp as its confirmation.\n\n To ensure users read the most recent version of Remote's Terms of Service, their **acceptance\n must be done within the last fifteen minutes prior the company creation action**.\n\n To retrieve this information, partners can provide an element with any text and a description\n explaining that by performing that action they are accepting Remote's Term of Service. For\n instance, the partner can add a checkbox or a \"Create Remote Account\" button followed by a\n description saying \"By creating an account, you agree to\n [Remote's Terms of Service](https://remote.com/terms-of-service). Also see Remote's\n [Privacy Policy](https://remote.com/privacy-policy)\".\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage companies (`company_management`) | - | Manage companies (`company:write`) |\n" }, "response": [ { "id": "52e4cf36-6ce9-4a44-91fe-c70665483f5d", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"company_owner_email\": \"\",\n \"company_owner_name\": \"\",\n \"country_code\": \"\",\n \"desired_currency\": \"GBP\",\n \"name\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"address_details\": {},\n \"bank_account_details\": {},\n \"email_domain\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies?address_details_json_schema_version=&bank_account_details_json_schema_version=&action=&async=&scope=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Complementary action(s) to perform when creating a company:\n\n- `get_oauth_access_tokens` returns the user's access and refresh tokens\n- `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only)\n\nIf `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send)\n", "key": "action", "value": "" }, { "description": "Whether the request should be performed async\n", "key": "async", "value": "" }, { "description": "Scope of the access token\n", "key": "scope", "value": "" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"data\": {\n \"company\": {\n \"address_details\": {},\n \"company_owner_email\": \"\",\n \"company_owner_user_id\": \"\",\n \"country_code\": \"\",\n \"created_at\": \"\",\n \"desired_currency\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"active\",\n \"updated_at\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"default_legal_entity_credit_risk_status\": \"not_started\",\n \"bank_account_details\": {},\n \"company_owner_name\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-52e4cf36-6ce9-4a44-91fe-c70665483f5d" }, { "id": "6577904f-90bf-46af-9496-a357e1d5bc94", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"company_owner_email\": \"\",\n \"company_owner_name\": \"\",\n \"country_code\": \"\",\n \"desired_currency\": \"GBP\",\n \"name\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"address_details\": {},\n \"bank_account_details\": {},\n \"email_domain\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies?address_details_json_schema_version=&bank_account_details_json_schema_version=&action=&async=&scope=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Complementary action(s) to perform when creating a company:\n\n- `get_oauth_access_tokens` returns the user's access and refresh tokens\n- `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only)\n\nIf `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send)\n", "key": "action", "value": "" }, { "description": "Whether the request should be performed async\n", "key": "async", "value": "" }, { "description": "Scope of the access token\n", "key": "scope", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-6577904f-90bf-46af-9496-a357e1d5bc94" }, { "id": "79f4b8db-a434-49b1-a2cc-c260ec3079a4", "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"company_owner_email\": \"\",\n \"company_owner_name\": \"\",\n \"country_code\": \"\",\n \"desired_currency\": \"GBP\",\n \"name\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"address_details\": {},\n \"bank_account_details\": {},\n \"email_domain\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies?address_details_json_schema_version=&bank_account_details_json_schema_version=&action=&async=&scope=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Complementary action(s) to perform when creating a company:\n\n- `get_oauth_access_tokens` returns the user's access and refresh tokens\n- `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only)\n\nIf `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send)\n", "key": "action", "value": "" }, { "description": "Whether the request should be performed async\n", "key": "async", "value": "" }, { "description": "Scope of the access token\n", "key": "scope", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-79f4b8db-a434-49b1-a2cc-c260ec3079a4" }, { "id": "fd688946-5fca-43f6-88e9-1cd1e9794185", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"company_owner_email\": \"\",\n \"company_owner_name\": \"\",\n \"country_code\": \"\",\n \"desired_currency\": \"GBP\",\n \"name\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"address_details\": {},\n \"bank_account_details\": {},\n \"email_domain\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies?address_details_json_schema_version=&bank_account_details_json_schema_version=&action=&async=&scope=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Complementary action(s) to perform when creating a company:\n\n- `get_oauth_access_tokens` returns the user's access and refresh tokens\n- `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only)\n\nIf `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send)\n", "key": "action", "value": "" }, { "description": "Whether the request should be performed async\n", "key": "async", "value": "" }, { "description": "Scope of the access token\n", "key": "scope", "value": "" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": {\n \"code\": \"resource_already_exists\",\n \"message\": \"The company with the provided EIN is already registered+\",\n \"resource_id\": \"\",\n \"resource_type\": \"company_creation\"\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-fd688946-5fca-43f6-88e9-1cd1e9794185" }, { "id": "0cc1ceb2-8517-4371-a62d-790f2ce00c7c", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"company_owner_email\": \"\",\n \"company_owner_name\": \"\",\n \"country_code\": \"\",\n \"desired_currency\": \"GBP\",\n \"name\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"address_details\": {},\n \"bank_account_details\": {},\n \"email_domain\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies?address_details_json_schema_version=&bank_account_details_json_schema_version=&action=&async=&scope=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Complementary action(s) to perform when creating a company:\n\n- `get_oauth_access_tokens` returns the user's access and refresh tokens\n- `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only)\n\nIf `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send)\n", "key": "action", "value": "" }, { "description": "Whether the request should be performed async\n", "key": "async", "value": "" }, { "description": "Scope of the access token\n", "key": "scope", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-0cc1ceb2-8517-4371-a62d-790f2ce00c7c" }, { "id": "d00e2816-18d7-40e8-81c7-fb6503fdf5b8", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"company_owner_email\": \"\",\n \"company_owner_name\": \"\",\n \"country_code\": \"\",\n \"desired_currency\": \"GBP\",\n \"name\": \"\",\n \"terms_of_service_accepted_at\": \"\",\n \"address_details\": {},\n \"bank_account_details\": {},\n \"email_domain\": \"\",\n \"external_id\": \"\",\n \"phone_number\": \"\",\n \"registration_number\": \"\",\n \"tax_number\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/companies?address_details_json_schema_version=&bank_account_details_json_schema_version=&action=&async=&scope=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies" ], "query": [ { "description": "Version of the address_details form schema", "key": "address_details_json_schema_version", "value": "" }, { "description": "Version of the bank_account_details form schema", "key": "bank_account_details_json_schema_version", "value": "" }, { "description": "Complementary action(s) to perform when creating a company:\n\n- `get_oauth_access_tokens` returns the user's access and refresh tokens\n- `send_create_password_email ` sends a reset password token to the company owner's email so they can log in using Remote UI (not needed if integration plans to use SSO only)\n\nIf `action` contains `send_create_password_email` you can redirect the user to [https://employ.remote.com/api-integration-new-password-send](https://employ.remote.com/api-integration-new-password-send)\n", "key": "action", "value": "" }, { "description": "Whether the request should be performed async\n", "key": "async", "value": "" }, { "description": "Scope of the access token\n", "key": "scope", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-d00e2816-18d7-40e8-81c7-fb6503fdf5b8" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-d7baa894-d368-42b6-89d2-c6b21dfc9a0c" } ], "id": "282b535a-e7f3-4241-9d70-754b647189a8", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-282b535a-e7f3-4241-9d70-754b647189a8" }, { "name": "company-managers", "item": [ { "name": "{user_id}", "item": [ { "name": "Deletes a Company Manager user", "id": "78b38dca-ceb6-44f7-80bc-5f0a1b661322", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "id": "46d86f30-7c79-4524-9c87-5212f5b6122d", "key": "user_id", "value": "", "description": "(Required) User ID" } ] }, "description": "Deletes a Company Manager user\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) |\n" }, "response": [ { "id": "62d88eb7-9691-46e0-be42-2b76be37a1ee", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-62d88eb7-9691-46e0-be42-2b76be37a1ee" }, { "id": "45a7f5bc-3515-43a6-af42-0f4438e14a09", "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-45a7f5bc-3515-43a6-af42-0f4438e14a09" }, { "id": "3d7b0310-ca4e-44c7-b408-f89bd9c029bc", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-3d7b0310-ca4e-44c7-b408-f89bd9c029bc" }, { "id": "88497031-59e9-46c7-824a-960e73c5af3c", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-88497031-59e9-46c7-824a-960e73c5af3c" }, { "id": "10c1a039-333b-4d46-bbf7-f501da4ab1b7", "name": "Unprocessable Entity", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-10c1a039-333b-4d46-bbf7-f501da4ab1b7" }, { "id": "3a7c6afa-df72-450c-a7a5-e9c7e62533de", "name": "Too many requests", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-3a7c6afa-df72-450c-a7a5-e9c7e62533de" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-78b38dca-ceb6-44f7-80bc-5f0a1b661322" }, { "name": "Show company manager user", "id": "5dfb7a4b-f810-4b86-9a74-caaee0215b1c", "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/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "id": "4c024c59-b2dc-41db-8cf7-8d4e5adcbc70", "key": "user_id", "value": "", "description": "(Required) User ID" } ] }, "description": "Shows a single company manager user\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) |\n" }, "response": [ { "id": "2a380341-1e8d-4ee8-b9a2-bdde2a7efc64", "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/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"company_manager\": {\n \"company_id\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"role\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-2a380341-1e8d-4ee8-b9a2-bdde2a7efc64" }, { "id": "65fb9e60-5133-46e2-a267-771b02aa4d6b", "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/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-65fb9e60-5133-46e2-a267-771b02aa4d6b" }, { "id": "f298a48e-6ec7-4f87-a765-8b15cf629e58", "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/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f298a48e-6ec7-4f87-a765-8b15cf629e58" }, { "id": "3c1fee1d-88e1-467e-beeb-e73a2b6274e7", "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/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-3c1fee1d-88e1-467e-beeb-e73a2b6274e7" }, { "id": "6e0aa0a9-3edb-40a5-9e0a-1e42c06de891", "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/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-6e0aa0a9-3edb-40a5-9e0a-1e42c06de891" }, { "id": "439ab7fe-8e10-4c46-9e2a-37340c6a2041", "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/company-managers/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-439ab7fe-8e10-4c46-9e2a-37340c6a2041" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-5dfb7a4b-f810-4b86-9a74-caaee0215b1c" } ], "id": "006b8220-04c7-4902-9bf1-c5268934b73a", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-006b8220-04c7-4902-9bf1-c5268934b73a" }, { "name": "List Company Managers", "id": "6d245216-b134-4742-a1d3-d68cc5b6bb93", "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/company-managers?company_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "A Company ID to filter the results (only applicable for Integration Partners).", "key": "company_id", "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": "List all company managers of an integration. If filtered by the company_id param,\nit lists only company managers belonging to the specified company.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View managers (`company_manager:read`) | Manage managers (`company_manager:write`) |\n" }, "response": [ { "id": "b2d5bcda-42f6-4123-94fb-949817da8928", "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/company-managers?company_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "A Company ID to filter the results (only applicable for Integration Partners).", "key": "company_id", "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 \"company_managers\": [\n {\n \"company_id\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"role\": \"\"\n },\n {\n \"company_id\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"role\": \"\"\n }\n ],\n \"current_page\": \"\",\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-b2d5bcda-42f6-4123-94fb-949817da8928" }, { "id": "3ca672c6-7388-4255-b5d8-661ff5d8f855", "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/company-managers?company_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "A Company ID to filter the results (only applicable for Integration Partners).", "key": "company_id", "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:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-3ca672c6-7388-4255-b5d8-661ff5d8f855" }, { "id": "a26518f3-c48b-40e5-bb12-4d6ca0fb75aa", "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/company-managers?company_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "A Company ID to filter the results (only applicable for Integration Partners).", "key": "company_id", "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:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-a26518f3-c48b-40e5-bb12-4d6ca0fb75aa" }, { "id": "7024d90f-856f-41d3-8277-7f7ac27bd19a", "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/company-managers?company_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "A Company ID to filter the results (only applicable for Integration Partners).", "key": "company_id", "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:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-7024d90f-856f-41d3-8277-7f7ac27bd19a" }, { "id": "942ee908-6d19-48c9-a6cd-b02eeb9f3620", "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/company-managers?company_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "A Company ID to filter the results (only applicable for Integration Partners).", "key": "company_id", "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:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-942ee908-6d19-48c9-a6cd-b02eeb9f3620" }, { "id": "6d0312dc-35ce-4d0a-9830-d9a0e7f46bf5", "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/company-managers?company_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "A Company ID to filter the results (only applicable for Integration Partners).", "key": "company_id", "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:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-6d0312dc-35ce-4d0a-9830-d9a0e7f46bf5" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-6d245216-b134-4742-a1d3-d68cc5b6bb93" }, { "name": "Create and invite a Company Manager", "id": "2e8663e4-0ecc-4d2a-8f90-c87b090a2833", "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 \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\",\n \"company_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-managers?actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "Complementary action(s) to perform when creating a company manager:\n\n- `no_invite` skips the email invitation step\n", "key": "actions", "value": "" } ] }, "description": "Create a Company Manager and sends the invitation email for signing in to the Remote Platform.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | - | Manage managers (`company_manager:write`) |\n" }, "response": [ { "id": "faf51d90-bd8f-4250-92d6-9a1d3229654f", "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 \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\",\n \"company_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-managers?actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "Complementary action(s) to perform when creating a company manager:\n\n- `no_invite` skips the email invitation step\n", "key": "actions", "value": "" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"company_manager\": {\n \"company_id\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"role\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-faf51d90-bd8f-4250-92d6-9a1d3229654f" }, { "id": "13c15174-c8fe-4a86-bb56-4c94b4933993", "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 \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\",\n \"company_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-managers?actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "Complementary action(s) to perform when creating a company manager:\n\n- `no_invite` skips the email invitation step\n", "key": "actions", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-13c15174-c8fe-4a86-bb56-4c94b4933993" }, { "id": "983c1b57-72de-49a6-b740-3865ae6c5039", "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 \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\",\n \"company_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-managers?actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "Complementary action(s) to perform when creating a company manager:\n\n- `no_invite` skips the email invitation step\n", "key": "actions", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-983c1b57-72de-49a6-b740-3865ae6c5039" }, { "id": "601b7cc4-1300-414f-858a-794896b0e06b", "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 \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\",\n \"company_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-managers?actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "Complementary action(s) to perform when creating a company manager:\n\n- `no_invite` skips the email invitation step\n", "key": "actions", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-601b7cc4-1300-414f-858a-794896b0e06b" }, { "id": "2016c5cf-4df4-4e5b-8a69-68c854657bf0", "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 \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\",\n \"company_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-managers?actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "Complementary action(s) to perform when creating a company manager:\n\n- `no_invite` skips the email invitation step\n", "key": "actions", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-2016c5cf-4df4-4e5b-8a69-68c854657bf0" }, { "id": "7cda2760-a9b3-4be1-b55d-6b0876adf795", "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 \"name\": \"\",\n \"email\": \"\",\n \"role\": \"\",\n \"company_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-managers?actions=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-managers" ], "query": [ { "description": "Complementary action(s) to perform when creating a company manager:\n\n- `no_invite` skips the email invitation step\n", "key": "actions", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-7cda2760-a9b3-4be1-b55d-6b0876adf795" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-2e8663e4-0ecc-4d2a-8f90-c87b090a2833" } ], "id": "811e5d7b-5648-43c5-92f2-1fcc8cc6290e", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-811e5d7b-5648-43c5-92f2-1fcc8cc6290e" }, { "name": "company-departments", "item": [ { "name": "List Company Departments", "id": "f98c8283-4139-4aa0-830d-c5ca841d1d29", "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/company-departments?company_id=&paginate=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-departments" ], "query": [ { "description": "(Required) Company ID", "key": "company_id", "value": "" }, { "description": "Paginate option. Default: true. When true, paginates response; otherwise, does not.", "key": "paginate", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "Lists all departments for the authorized company specified in the request.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View departments (`company_department:read`) | Manage departments (`company_department:write`) |\n" }, "response": [ { "id": "951c230f-7d21-413f-a19d-fe7d57f78f16", "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/company-departments?company_id=&paginate=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-departments" ], "query": [ { "description": "(Required) Company ID", "key": "company_id", "value": "" }, { "description": "Paginate option. Default: true. When true, paginates response; otherwise, does not.", "key": "paginate", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"company_departments\": [\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"company_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-951c230f-7d21-413f-a19d-fe7d57f78f16" }, { "id": "88906276-5f80-4fb9-b5e9-02c258ae3ebe", "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/company-departments?company_id=&paginate=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-departments" ], "query": [ { "description": "(Required) Company ID", "key": "company_id", "value": "" }, { "description": "Paginate option. Default: true. When true, paginates response; otherwise, does not.", "key": "paginate", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-88906276-5f80-4fb9-b5e9-02c258ae3ebe" }, { "id": "f50608da-18de-4bd0-953f-a422a1f2fcd5", "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/company-departments?company_id=&paginate=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-departments" ], "query": [ { "description": "(Required) Company ID", "key": "company_id", "value": "" }, { "description": "Paginate option. Default: true. When true, paginates response; otherwise, does not.", "key": "paginate", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f50608da-18de-4bd0-953f-a422a1f2fcd5" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f98c8283-4139-4aa0-830d-c5ca841d1d29" }, { "name": "Create New Department", "id": "e5cc2057-f941-4042-aeb9-bc0fbfd42bd2", "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 \"company_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-departments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-departments" ] }, "description": "Creates a new department in the specified company. Department names may be non-unique and must be non-empty with no more than 255 characters (Unicode code points).\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | - | Manage departments (`company_department:write`) |\n" }, "response": [ { "id": "d7a1ca66-7f34-4e73-9097-a038e29f9b73", "name": "Created", "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 \"company_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-departments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-departments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"company_department\": {\n \"id\": \"\",\n \"company_id\": \"\",\n \"name\": \"\"\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-d7a1ca66-7f34-4e73-9097-a038e29f9b73" }, { "id": "8a1f4a40-7033-476e-ae6a-b7fcf80dbd84", "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 \"company_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-departments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-departments" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-8a1f4a40-7033-476e-ae6a-b7fcf80dbd84" }, { "id": "89bf56d2-0e99-418a-a02d-c10ad318fa17", "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 \"company_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/company-departments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-departments" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-89bf56d2-0e99-418a-a02d-c10ad318fa17" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-e5cc2057-f941-4042-aeb9-bc0fbfd42bd2" } ], "id": "acddc117-3c04-46cc-9e8a-cc9151c60307", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-acddc117-3c04-46cc-9e8a-cc9151c60307" }, { "name": "company-currencies", "item": [ { "name": "List company supported currencies", "id": "8898037b-3f32-4bde-9b8b-e0330e61e91b", "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/company-currencies", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-currencies" ] }, "description": "List company supported currencies\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View company currencies (`company_currencies:read`) | - |\n" }, "response": [ { "id": "a391af00-a056-4836-bb4d-d437211b0193", "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/company-currencies", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-currencies" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"company_currencies\": [\n {\n \"code\": \"\",\n \"slug\": \"\"\n },\n {\n \"code\": \"\",\n \"slug\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-a391af00-a056-4836-bb4d-d437211b0193" }, { "id": "59722cc8-b4eb-4a6e-914b-cb336063e1b0", "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/company-currencies", "host": [ "{{baseUrl}}" ], "path": [ "v1", "company-currencies" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-59722cc8-b4eb-4a6e-914b-cb336063e1b0" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-8898037b-3f32-4bde-9b8b-e0330e61e91b" } ], "id": "8656f404-3527-4297-b05f-86bc9d81aa55", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-8656f404-3527-4297-b05f-86bc9d81aa55" }, { "name": "employments", "item": [ { "name": "{employment_id}", "item": [ { "name": "company-structure-nodes", "item": [ { "name": "List company structure nodes", "id": "8761909b-2981-4242-9e91-f6781b415e61", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/company-structure-nodes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "company-structure-nodes" ], "variable": [ { "id": "dbdfb0c7-f852-4288-bcc1-b17bb3663d5e", "key": "employment_id", "value": "", "description": "(Required) Employment ID" } ] }, "description": "Shows all the company structure nodes of an employment.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | View company structure (`company_structure:read`) | - |\n" }, "response": [ { "id": "5be87c54-8505-4f95-ac9a-945c1cab7bc0", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/company-structure-nodes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "company-structure-nodes" ], "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 \"company_structure_nodes\": [\n {\n \"id\": \"\",\n \"attributes\": {\n \"minim3\": \"elit dolo\"\n },\n \"company_structure\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"parent\": {\n \"attributes\": {\n \"ullamco_0b\": false,\n \"quis__15\": -13430342,\n \"ex_a8c\": 25628321.326895162,\n \"do__1\": 86262285\n },\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"attributes\": {\n \"eu_3\": true,\n \"sita\": -29572121.172663525\n },\n \"company_structure\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"parent\": {\n \"attributes\": {\n \"labore_96\": -65969667.189344294,\n \"Duis47a\": true,\n \"nulla_aa\": -68967980,\n \"aliquip_89\": -51221499\n },\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-5be87c54-8505-4f95-ac9a-945c1cab7bc0" }, { "id": "ababb7b6-2925-4007-a04a-3d91e107d820", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/company-structure-nodes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "company-structure-nodes" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-ababb7b6-2925-4007-a04a-3d91e107d820" }, { "id": "7a8ef9b3-4fbf-434b-9908-9ed30fbebd50", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/company-structure-nodes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "company-structure-nodes" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-7a8ef9b3-4fbf-434b-9908-9ed30fbebd50" }, { "id": "84511850-fa19-4fee-90f5-07f71cd2bb2d", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/employments/:employment_id/company-structure-nodes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employments", ":employment_id", "company-structure-nodes" ], "variable": [ { "key": "employment_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-84511850-fa19-4fee-90f5-07f71cd2bb2d" } ], "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-8761909b-2981-4242-9e91-f6781b415e61" } ], "id": "2893073e-be5a-4e5c-9c0e-9fdd79eab9e7", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-2893073e-be5a-4e5c-9c0e-9fdd79eab9e7" } ], "id": "aa371f77-b5fc-4f95-8205-e193fe31044b", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-aa371f77-b5fc-4f95-8205-e193fe31044b" } ], "id": "a49a6b82-ee22-450a-b2a4-e66b4fb30a77", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-a49a6b82-ee22-450a-b2a4-e66b4fb30a77" } ], "id": "f21b3350-b426-408d-85b4-6afc1ef495c4", "createdAt": "2026-07-28T02:45:06.000Z", "updatedAt": "2026-07-28T02:45:06.000Z", "uid": "35240-f21b3350-b426-408d-85b4-6afc1ef495c4" } ], "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/" } ] }