{ "info": { "name": "Employment Hero API", "description": "REST API for the Employment Hero platform. Base URL: https://api.employmenthero.com/api", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Authentication", "item": [ { "name": "Access Token", "request": { "method": "POST", "header": [], "url": { "raw": "https://oauth.employmenthero.com/oauth2/token?client_id=&client_secret=&grant_type=&code=&redirect_uri=", "protocol": "https", "host": [ "oauth", "employmenthero", "com" ], "path": [ "oauth2", "token" ], "query": [ { "key": "client_id", "value": "", "disabled": true }, { "key": "client_secret", "value": "", "disabled": true }, { "key": "grant_type", "value": "", "disabled": true }, { "key": "code", "value": "", "disabled": true }, { "key": "redirect_uri", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Authorization", "request": { "method": "GET", "header": [], "url": { "raw": "https://oauth.employmenthero.com/oauth2/authorize?client_id=&redirect_uri=&response_type=", "protocol": "https", "host": [ "oauth", "employmenthero", "com" ], "path": [ "oauth2", "authorize" ], "query": [ { "key": "client_id", "value": "", "disabled": true }, { "key": "redirect_uri", "value": "", "disabled": true }, { "key": "response_type", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Refresh Access Token", "request": { "method": "POST", "header": [], "url": { "raw": "https://oauth.employmenthero.com/oauth2/token?client_id=&client_secret=&grant_type=&code=&redirect_uri=&refresh_token=", "protocol": "https", "host": [ "oauth", "employmenthero", "com" ], "path": [ "oauth2", "token" ], "query": [ { "key": "client_id", "value": "", "disabled": true }, { "key": "client_secret", "value": "", "disabled": true }, { "key": "grant_type", "value": "", "disabled": true }, { "key": "code", "value": "", "disabled": true }, { "key": "redirect_uri", "value": "", "disabled": true }, { "key": "refresh_token", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Bank Account", "item": [ { "name": "Get Bank Accounts Config V1", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/bank_accounts?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "bank_accounts" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Bank Accounts Config V2", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v2/organisations/{{organisation_id}}/employees/{{employee_id}}/bank_accounts?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v2", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "bank_accounts" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Certification", "item": [ { "name": "Get Certifications Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/certifications?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "certifications" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Certification Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/certifications/{{certification_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "certifications", "{{certification_id}}" ] }, "response": [] }, "response": [] }, { "name": "Create Certification Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/certifications", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "certifications" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Working With Children Check\",\n \"type\": \"check\",\n \"description\": \"Required for all staff working with children under 18 years of age\",\n \"state\": \"NSW\",\n \"mandatory\": true,\n \"due_within_days\": 30,\n \"supporting_documentation\": true,\n \"certification_number_allowed\": true,\n \"confirm_driving_offenses\": false,\n \"use_expiry_date\": false,\n \"frequency_attributes\": {\n \"frequency\": \"renewing\",\n \"repeat\": \"months\",\n \"timer\": 36\n },\n \"assignees\": {\n \"assigned_to_all_organisation_members\": false,\n \"assigned_to_all_organisation_contractors\": false,\n \"employee_ids\": [\n \"assignee-member-uuid-1234\"\n ],\n \"contractor_ids\": [\n \"assignee-contractor-uuid-1234\"\n ],\n \"group_ids\": [\n \"assignee-group-uuid-1234\"\n ],\n \"work_location_ids\": [\n \"assignee-work-location-uuid-1234\"\n ]\n },\n \"approval_required\": true,\n \"approvers\": {\n \"approvable_by_direct_managers\": true,\n \"approvable_by_indirect_managers\": false,\n \"employee_ids\": [\n \"approver-member-uuid-1234\"\n ],\n \"group_ids\": [\n \"approver-group-uuid-1234\"\n ],\n \"work_location_ids\": [\n \"approver-work-location-uuid-1234\"\n ]\n },\n \"additional_info_files\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Certification Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/certifications/{{certification_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "certifications", "{{certification_id}}" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Name Goes Here\",\n \"description\": \"Updated Description Goes Here\",\n \"state\": \"TAS\",\n \"due_within_days\": 14,\n \"supporting_documentation\": false,\n \"certification_number_allowed\": false,\n \"confirm_driving_offenses\": false,\n \"assignees\": {\n \"assigned_to_all_organisation_members\": false,\n \"assigned_to_all_organisation_contractors\": true,\n \"employee_ids\": [\n \"assignee-member-uuid-1234\"\n ],\n \"contractor_ids\": [\n \"assignee-contractor-uuid-1234\"\n ],\n \"group_ids\": [\n \"assignee-group-uuid-1234\"\n ],\n \"work_location_ids\": [\n \"assignee-work-location-uuid-1234\"\n ]\n },\n \"approval_required\": true,\n \"approvers\": {\n \"approvable_by_direct_managers\": true,\n \"approvable_by_indirect_managers\": true,\n \"employee_ids\": [\n \"approver-member-uuid-1234\"\n ],\n \"group_ids\": [\n \"approver-group-uuid-1234\"\n ],\n \"work_location_ids\": [\n \"approver-work-location-uuid-1234\"\n ]\n },\n \"use_expiry_date\": false,\n \"frequency_attributes\": {\n \"frequency\": \"renewing\",\n \"repeat\": \"days\",\n \"timer\": 10\n },\n \"additional_info_files\": [],\n \"send_notify_update_email\": false,\n \"reset_member_licence_status\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Certification Polling Status Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/certifications/polling_status?polling_key=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "certifications", "polling_status" ], "query": [ { "key": "polling_key", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Archive Status Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/certifications/{{certification_id}}/archive_status", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "certifications", "{{certification_id}}", "archive_status" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"status\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Certification Config", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/certifications/{{certification_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "certifications", "{{certification_id}}" ] }, "response": [] }, "response": [] }, { "name": "File Uploads Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/certifications/file_uploads", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "certifications", "file_uploads" ] }, "response": [], "body": { "mode": "formdata", "raw": "", "formdata": [ { "key": "files", "src": null, "type": "file" } ] } }, "response": [] } ] }, { "name": "Contractor Job History", "item": [ { "name": "Get Job Histories Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/job_histories?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "job_histories" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Cost Centre", "item": [ { "name": "Get Cost Centres Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/cost_centres?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "cost_centres" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Custom Field", "item": [ { "name": "Get Custom Fields Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/custom_fields?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "custom_fields" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Department", "item": [ { "name": "Create Department Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/departments", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "departments" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"work_site_id\": \"bdf48551-d061-45d2-b30f-9d78279f0707\",\n \"name\": \"Engineering Department\",\n \"clock_in_time\": \"09:00\",\n \"clock_out_time\": \"17:00\",\n \"days_applied\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\"\n ],\n \"member_ids\": [\n \"5388432b-2aa1-46b3-ad8c-f7c46356bb56\",\n \"032de036-9597-4119-be86-8602c3e2e363\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Department Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/departments/{{department_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "departments", "{{department_id}}" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Engineering Department\",\n \"clock_in_time\": \"09:00\",\n \"clock_out_time\": \"17:00\",\n \"days_applied\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\"\n ],\n \"member_ids\": [\n \"5388432b-2aa1-46b3-ad8c-f7c46356bb56\",\n \"032de036-9597-4119-be86-8602c3e2e363\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Document", "item": [ { "name": "Get Documents Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/documents?query=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "documents" ], "query": [ { "key": "query", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Create Document Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/documents", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "documents" ] }, "response": [], "body": { "mode": "formdata", "raw": "", "formdata": [ { "key": "file", "src": null, "type": "file" }, { "key": "name", "value": "", "type": "text" }, { "key": "tags", "value": "", "type": "text" }, { "key": "access_permissions", "value": "", "type": "text" } ] } }, "response": [] } ] }, { "name": "Emergency Contact", "item": [ { "name": "Get Emergency Contacts Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/emergency_contacts?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "emergency_contacts" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Employee", "item": [ { "name": "Get Employees Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees?member_type=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees" ], "query": [ { "key": "member_type", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Employee Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{id}}" ] }, "response": [] }, "response": [] }, { "name": "Quick Add Employee Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/quick_add_employee", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "quick_add_employee" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"employing_entity_id\": \"3a41ab5f-fd18-4c99-b475-040a098dac89\",\n \"first_name\": \"First Name\",\n \"last_name\": \"Last Name\",\n \"full_legal_name\": \"Full Legal Name\",\n \"email\": \"dev@example.com\",\n \"date_of_birth\": \"1995-01-01\",\n \"work_location\": {\n \"id\": \"b992fc49-7e98-4743-b53b-51bec9cf4dc3\",\n \"name\": \"Sydney Office\",\n \"country\": \"AU\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Quick Add Contractor Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/quick_add_contractor", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "quick_add_contractor" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"trading_name\": \"Trading name of business\",\n \"first_name\": \"John\",\n \"last_name\": \"Contractor\",\n \"full_legal_name\": \"John Contractor\",\n \"email\": \"john.contractor@example.com\",\n \"date_of_birth\": \"1990-01-01\",\n \"business_detail\": {\n \"country\": \"AU\",\n \"number\": \"ABN123456789\",\n \"business_type\": \"Company\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Polling Onboard Employee Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/polling_onboard_employee", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "polling_onboard_employee" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"user_attributes\": {\n \"email\": \"employee@example.com\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"full_legal_name\": \"Johnathan Doe\",\n \"employing_entity_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"employment_type\": \"Full-time\",\n \"date_of_birth\": \"1990-01-15\",\n \"start_date\": \"2025-07-02\",\n \"anniversary_date\": \"2026-07-02\",\n \"job_title\": \"3D Artist\",\n \"industry_standard_job_title\": \"3D Visual Artist\",\n \"current_salary_version_currency\": \"AUD\",\n \"salary\": 1000000,\n \"roster\": \"Annum\",\n \"probation_length\": 3,\n \"primary_manager_id\": \"b1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"secondary_manager_id\": \"c1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"employment_detail\": {\n \"remote\": \"no\",\n \"province_of_employment\": \"Ontario\",\n \"confirmed_date\": \"2025-06-15\"\n },\n \"work_location\": {\n \"id\": \"b992fc49-7e98-4743-b53b-51bec9cf4dc3\",\n \"name\": \"Sydney\",\n \"country\": \"AU\"\n },\n \"teams\": [\n \"d1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n ],\n \"cost_centre_id\": \"f1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"secondary_cost_centres_list\": \"g1b2c3d4-e5f6-7890-abcd-ef1234567890,h1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"sync_with_payroll\": true,\n \"system_access_date\": \"2025-07-02\",\n \"hours_per_week\": 40,\n \"typical_work_day\": 8,\n \"full_time_equivalent_units\": 1,\n \"days_per_week\": 5,\n \"zero_hour_based\": false,\n \"clock_me_in\": false,\n \"annualised_salary\": false,\n \"timesheet_sync_option\": \"sync_timesheets_as_exceptions\",\n \"leave_allowance_template_id\": \"i1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"automatically_pay_employee\": false,\n \"employee_portal_access_enabled\": true,\n \"timesheet_type\": 1,\n \"payroll_detail\": {\n \"stp_income_type\": \"salary_and_wages\"\n },\n \"contract_type\": \"Permanent\",\n \"end_date\": \"2026-12-31\",\n \"superannuation_amount\": 3,\n \"trigger_onboarding_checklists\": true,\n \"vacation_pay_percentage\": 4,\n \"vacation_pay_method\": \"bankAccruedVacationPay\",\n \"employee_paid_irregularly\": false,\n \"apply_rolled_up_holiday_pay\": false,\n \"rolled_up_holiday_pay_percentage\": 12,\n \"apprentice\": \"not_an_apprentice\",\n \"nwm_nlw_eligibility\": \"eligible_for_nwm\",\n \"code\": \"EMP001\",\n \"pay_category_id\": \"j1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"pay_schedule_id\": \"k1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"kiwi_saver_attributes\": {\n \"employer_enrollment_status\": \"automatically_enroll\",\n \"employer_contribution\": 3\n },\n \"my_nric_details\": {\n \"residence_type\": \"malaysian\",\n \"residence_status\": true,\n \"worker_status\": \"normal\",\n \"income_tax_number\": \"IT12345678\",\n \"religion\": \"Buddhist\",\n \"ethnicity\": \"Chinese\",\n \"dependent_children\": 2,\n \"pcb_tax_borne\": false,\n \"employee_epf_rate\": \"11\",\n \"socso_type\": \"employment_injury_and_invalidity_scheme\",\n \"eis_exempt\": false,\n \"epf_number\": \"EPF123456789\",\n \"identity_card_number\": \"123456789012\",\n \"passport_number\": \"A12345678\",\n \"passport_issuing_country\": \"MY\",\n \"passport_expiry_date\": \"2030-12-31\",\n \"work_pass_type\": \"employment_pass\",\n \"ssfw_number\": \"SSFW123456\",\n \"epf_contribution_type\": \"member_after_august_1998\"\n },\n \"nric_details\": {\n \"legal_status\": \"citizen\",\n \"nric_fin_number\": \"S1234567A\",\n \"nric_fin_type\": \"nric\",\n \"obtained_residency_date\": \"2010-01-01\",\n \"cpf_contribution_option\": \"graduated\",\n \"obtained_approval_date\": \"2010-01-01\",\n \"expiry_date\": \"2030-12-31\",\n \"nationality\": \"Singaporean\",\n \"ethnicity\": \"Chinese\",\n \"religion\": \"Buddhist\",\n \"covered_by_employment_act\": \"yes\",\n \"employee_group\": \"executive\",\n \"is_exempt_from_skills_dev_levy\": false,\n \"is_exempt_from_cpf\": false\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Polling Onboard Result Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/onboard/polling_status?polling_key={polling_key}?polling_key=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "onboard", "polling_status?polling_key={polling_key}" ], "query": [ { "key": "polling_key", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Update Personal Details Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/personal_details", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "personal_details" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"title\": \"Mr\",\n \"first_name\": \"John\",\n \"middle_name\": \"Michael\",\n \"last_name\": \"Smith\",\n \"known_as\": \"Johnny\",\n \"gender\": \"Male\",\n \"pronouns\": \"He/Him\",\n \"address_attributes\": {\n \"country\": \"AU\",\n \"line_1\": \"123 Main Street\",\n \"line_2\": \"Apt 4B\",\n \"line_3\": \"Building C\",\n \"suburb\": \"Sydney\",\n \"city\": \"Sydney\",\n \"state\": \"NSW2\",\n \"postcode\": \"20002\",\n \"block_number\": \"1232\",\n \"unit_number\": \"4B2\",\n \"level_number\": \"22\",\n \"street_name\": \"Main Street\",\n \"address_type\": \"Residential\"\n },\n \"nationality\": \"Australian\",\n \"date_of_birth\": \"1990-01-15\",\n \"marital_status\": \"In a Relationship\",\n \"personal_email\": \"example@example.com\",\n \"personal_mobile_number\": \"+614123456789\",\n \"home_phone\": \"+614123456789\",\n \"display_mobile_in_staff_directory\": true,\n \"full_legal_name\": \"John Michael Smith\",\n \"biography\": \"Experienced software engineer with 10+ years in web development.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Employment Details Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/employment_details", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "employment_details" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"code\": \"code\",\n \"cost_centre_id\": \"0139ebb7-6f3e-4bc0-954e-9e50614fccd1\",\n \"additional_cost_centre_ids\": [\n {\n \"id\": \"0139ebb7-6f3e-4bc0-954e-9e50614fccd1\"\n },\n {\n \"id\": \"0139ebb7-6f3e-4bc0-954e-9e50614fccd1\"\n }\n ],\n \"primary_manager_id\": \"primary_manager_id\",\n \"secondary_manager_id\": \"secondary_manager_id\",\n \"team_ids\": [],\n \"probation_length\": 20.5,\n \"company_email\": \"my.company@email.com\",\n \"company_mobile\": \"012345678\",\n \"company_landline\": \"087654321\",\n \"start_date\": \"2025-01-01\",\n \"system_access_date\": \"2025-01-02\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Contractor Details Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/contractor_details", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "contractor_details" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"trading_name\": \"Acme Consulting Pty Ltd\",\n \"abn\": \"80112233445\",\n \"business_detail\": {\n \"country\": \"AU\",\n \"number\": \"ACN987654321\",\n \"business_type\": \"sole_trader\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Employee Config", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}" ] }, "response": [] }, "response": [] } ] }, { "name": "Employee Certification Detail", "item": [ { "name": "Get Employee Certification Details Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/certifications?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "certifications" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Upload Employee Certification Files Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/certifications/file_uploads", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "certifications", "file_uploads" ] }, "response": [], "body": { "mode": "formdata", "raw": "", "formdata": [ { "key": "files", "src": null, "type": "file" } ] } }, "response": [] }, { "name": "Update Employee Certification Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/certifications/{{id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "certifications", "{{id}}" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"completion_date\": \"2024-06-15\",\n \"expiry_date\": \"2026-06-15\",\n \"certification_number\": \"WWCC-123456\",\n \"documents_to_keep\": [\n \"f1e2d3c4-b5a6-7890-fedc-ba9876543210\"\n ],\n \"documents_to_add\": [\n \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Employee Custom Field", "item": [ { "name": "Get Employee Custom Fields Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/custom_fields?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "custom_fields" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Employing Entity", "item": [ { "name": "Get Employing Entities Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employing_entities?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employing_entities" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Employment History", "item": [ { "name": "Get Employment Histories Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/employment_histories?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "employment_histories" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Kiosk Member", "item": [ { "name": "Get Kiosk Members Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/kiosk_members?query=&cost_centre_uuids=&work_site_uuids=&kiosk_access_statuses=&sort=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "kiosk_members" ], "query": [ { "key": "query", "value": "", "disabled": true }, { "key": "cost_centre_uuids", "value": "", "disabled": true }, { "key": "work_site_uuids", "value": "", "disabled": true }, { "key": "kiosk_access_statuses", "value": "", "disabled": true }, { "key": "sort", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Bulk Grant Access Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/kiosk_members/bulk_grant_access", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "kiosk_members", "bulk_grant_access" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"member_ids\": [\n \"6664453a-c118-48f1-897e-3df62d45bd84\",\n \"b992fc49-7e98-4743-b53b-51bec9cf4dc3\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Bulk Revoke Access Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/kiosk_members/bulk_revoke_access", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "kiosk_members", "bulk_revoke_access" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"member_ids\": [\n \"6664453a-c118-48f1-897e-3df62d45bd84\",\n \"b992fc49-7e98-4743-b53b-51bec9cf4dc3\"\n ],\n \"notify_members\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Leave Category", "item": [ { "name": "Get Leave Categories Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/leave_categories?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "leave_categories" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Leave Request", "item": [ { "name": "Get Leave Requests Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/leave_requests?start_date=&end_date=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "leave_requests" ], "query": [ { "key": "start_date", "value": "", "disabled": true }, { "key": "end_date", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Leave Request Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/leave_requests/{{id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "leave_requests", "{{id}}" ] }, "response": [] }, "response": [] }, { "name": "Create Leave Request Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/leave_requests", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "leave_requests" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"leave_category_id\": \"0139ebb7-6f3e-4bc0-954e-9e50614fccd1\",\n \"start_date\": \"2025-12-25\",\n \"end_date\": \"2025-12-27\",\n \"comment\": \"Holiday vacation\",\n \"hours_per_day\": [\n {\n \"date\": \"2025-12-25\",\n \"hours\": 7.6\n },\n {\n \"date\": \"2025-12-26\",\n \"hours\": 7.6\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Organisation", "item": [ { "name": "Get Organisations Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Organisation Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{id}}" ] }, "response": [] }, "response": [] } ] }, { "name": "Pay Detail", "item": [ { "name": "Get Pay Details Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/pay_details?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "pay_details" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Payslip", "item": [ { "name": "Get Payslips Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/payslips?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "payslips" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Payslip Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/payslips/{{payslip_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "payslips", "{{payslip_id}}" ] }, "response": [] }, "response": [] }, { "name": "Generate Payslip Pdf Config", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/payslips/{{payslip_id}}/pdf_gen", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "payslips", "{{payslip_id}}", "pdf_gen" ] }, "response": [] }, "response": [] } ] }, { "name": "Policy", "item": [ { "name": "Get Policies Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/policies?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "policies" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Position", "item": [ { "name": "Create Position Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/positions", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "positions" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Position\",\n \"work_site_id\": \"382443a5-f39d-4d55-bf30-1489f7fd6acf\",\n \"cost_centre_id\": \"0b7ef29a-5172-4437-a6fd-2c9291eb04a9\",\n \"member_ids\": [\n \"fe179bf9-19e3-4779-b458-e2d418127186\"\n ],\n \"team_ids\": [\n \"7d5046b1-b63c-427c-bfdd-917f733e8496\"\n ],\n \"color\": \"smalt\",\n \"team_assign_mode\": \"auto_assign\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Position Config", "request": { "method": "PATCH", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/positions/{{position_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "positions", "{{position_id}}" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated Position Name\",\n \"cost_centre_id\": \"0b7ef29a-5172-4437-a6fd-2c9291eb04a9\",\n \"member_ids\": [\n \"fe179bf9-19e3-4779-b458-e2d418127186\"\n ],\n \"team_ids\": [\n \"7d5046b1-b63c-427c-bfdd-917f733e8496\"\n ],\n \"color\": \"green\",\n \"team_assign_mode\": \"auto_assign\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Rostered Shift", "item": [ { "name": "Get Rostered Shifts Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/rostered_shifts?from_date=&to_date=&statuses=&location_ids=&member_ids=&unassigned_shifts_only=&exclude_shifts_overlapping_from_date=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "rostered_shifts" ], "query": [ { "key": "from_date", "value": "", "disabled": true }, { "key": "to_date", "value": "", "disabled": true }, { "key": "statuses", "value": "", "disabled": true }, { "key": "location_ids", "value": "", "disabled": true }, { "key": "member_ids", "value": "", "disabled": true }, { "key": "unassigned_shifts_only", "value": "", "disabled": true }, { "key": "exclude_shifts_overlapping_from_date", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Rostered Shift Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/rostered_shifts/{{id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "rostered_shifts", "{{id}}" ] }, "response": [] }, "response": [] }, { "name": "Get Rostered Shift Cost Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/rostered_shifts/cost?start_date=&end_date=&work_site_ids=&position_ids=&location_ids=&member_ids=&statuses=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "rostered_shifts", "cost" ], "query": [ { "key": "start_date", "value": "", "disabled": true }, { "key": "end_date", "value": "", "disabled": true }, { "key": "work_site_ids", "value": "", "disabled": true }, { "key": "position_ids", "value": "", "disabled": true }, { "key": "location_ids", "value": "", "disabled": true }, { "key": "member_ids", "value": "", "disabled": true }, { "key": "statuses", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Roles Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/roles?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "roles" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Bulk Create Rostered Shifts Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/rostered_shifts/bulk_create", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "rostered_shifts", "bulk_create" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"start_date_time\": \"2025-11-06T09:00:00.000Z\",\n \"end_date_time\": \"2025-11-07T09:00:00.000Z\",\n \"number_of_shifts\": 10,\n \"member_ids\": [\n \"6664453a-c118-48f1-897e-3df62d45bd84\"\n ],\n \"biddable_member_ids\": [\n \"6664453a-c118-48f1-897e-3df62d45bd84\"\n ],\n \"breaks\": [\n {\n \"start_time\": \"2025-11-06T12:00:00.000Z\",\n \"end_time\": \"2025-11-06T13:00:00.000Z\"\n }\n ],\n \"notes\": \"Bulk created shifts\",\n \"published\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Rostered Shifts Bulk Create Status Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/rostered_shifts/job_status/{{job_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "rostered_shifts", "job_status", "{{job_id}}" ] }, "response": [] }, "response": [] } ] }, { "name": "Superannuation Detail", "item": [ { "name": "Get Superannuation Detail Config V1", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/superannuation_detail", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "superannuation_detail" ] }, "response": [] }, "response": [] }, { "name": "Get Superannuation Detail Config V2", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v2/organisations/{{organisation_id}}/employees/{{employee_id}}/superannuation_detail", "host": [ "{{base_url}}" ], "path": [ "v2", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "superannuation_detail" ] }, "response": [] }, "response": [] } ] }, { "name": "Tax Declaration", "item": [ { "name": "Get Tax Declaration Config V1", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/tax_declaration", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "tax_declaration" ] }, "response": [] }, "response": [] }, { "name": "Get Tax Declaration Config V2", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v2/organisations/{{organisation_id}}/employees/{{employee_id}}/tax_declaration", "host": [ "{{base_url}}" ], "path": [ "v2", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "tax_declaration" ] }, "response": [] }, "response": [] } ] }, { "name": "Team", "item": [ { "name": "Get Teams Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/teams?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "teams" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Team Employees Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/teams/{{team_id}}/employees?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "teams", "{{team_id}}", "employees" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Timesheet Entry", "item": [ { "name": "Get Timesheet Entries Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/timesheet_entries?start_date=&end_date=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "timesheet_entries" ], "query": [ { "key": "start_date", "value": "", "disabled": true }, { "key": "end_date", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Create Timesheet Entries Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/timesheet_entries", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "timesheet_entries" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"timesheets\": [\n {\n \"employee_id\": \"001c20e3-c752-4a46-81a1-a5e476e42d06\",\n \"date\": \"2024-01-15\",\n \"start_time\": \"2024-01-15T09:00:00+11:00\",\n \"end_time\": \"2024-01-15T17:00:00+11:00\",\n \"comment\": \"Regular work day\",\n \"breaks\": [\n {\n \"start_time\": \"2024-01-15T12:00:00+11:00\",\n \"end_time\": \"2024-01-15T13:00:00+11:00\"\n }\n ],\n \"units\": 7.5,\n \"position_id\": \"87f926ac-1a21-45aa-a86e-302815e7e781\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Unavailability", "item": [ { "name": "Get Unavailabilities Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/unavailabilities?from_date=&to_date=&location_id=&member_id=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "unavailabilities" ], "query": [ { "key": "from_date", "value": "", "disabled": true }, { "key": "to_date", "value": "", "disabled": true }, { "key": "location_id", "value": "", "disabled": true }, { "key": "member_id", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Get Unavailability Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/unavailabilities/{{id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "unavailabilities", "{{id}}" ] }, "response": [] }, "response": [] } ] }, { "name": "Work Eligibility", "item": [ { "name": "Get Work Eligibility Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/employees/{{employee_id}}/work_eligibility", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "employees", "{{employee_id}}", "work_eligibility" ] }, "response": [] }, "response": [] } ] }, { "name": "Work Location", "item": [ { "name": "Get Work Locations Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/work_locations?page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "work_locations" ], "query": [ { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] }, { "name": "Work Site", "item": [ { "name": "Get Work Sites Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/work_sites?query=&show_archived=&work_site_ids=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "work_sites" ], "query": [ { "key": "query", "value": "", "disabled": true }, { "key": "show_archived", "value": "", "disabled": true }, { "key": "work_site_ids", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] }, { "name": "Create Work Site Config", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/work_sites", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "work_sites" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Work Site 1\",\n \"address\": {\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Apt 4B\",\n \"line_3\": \"Building 5\",\n \"country\": \"US\",\n \"postcode\": \"12345\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"suburb\": \"Manhattan\",\n \"geolocation\": {\n \"latitude\": 40.7128,\n \"longitude\": -74.006\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Work Site Config", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/work_sites/{{work_site_id}}", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "work_sites", "{{work_site_id}}" ] }, "response": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Work Site 1\",\n \"address\": {\n \"line_1\": \"123 Main St\",\n \"line_2\": \"Apt 4B\",\n \"line_3\": \"Building 5\",\n \"country\": \"US\",\n \"postcode\": \"12345\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"suburb\": \"Manhattan\",\n \"geolocation\": {\n \"latitude\": 40.7128,\n \"longitude\": -74.006\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Work Type", "item": [ { "name": "Get Work Types Config", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}" } ], "url": { "raw": "{{base_url}}/v1/organisations/{{organisation_id}}/work_types?payroll_info_id=&page_index=&item_per_page=", "host": [ "{{base_url}}" ], "path": [ "v1", "organisations", "{{organisation_id}}", "work_types" ], "query": [ { "key": "payroll_info_id", "value": "", "disabled": true }, { "key": "page_index", "value": "", "disabled": true }, { "key": "item_per_page", "value": "", "disabled": true } ] }, "response": [] }, "response": [] } ] } ], "variable": [ { "key": "base_url", "value": "https://api.employmenthero.com/api", "type": "string" }, { "key": "access_token", "value": "", "type": "string" } ] }