Employment HeroThis endpoint retrieves a paginated list of work types available within the specified organisation.
Work types represent different categories of work time and leave that can be associated with timesheet entries and leave requests. Each work type maps to underlying payroll categories such as pay categories, leave categories, or shift conditions.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/work_typesPath Parameters
The ID of the organisation to retrieve
Query Parameters
Optional payroll info ID for filtering work types. If provided, returns work types associated with the specified payroll connection.
Current page index
11Number of items per page
20100Response Body
A JSON object with a data property that contains an array of work type objects and pagination information. Each work type object includes details about the work type, its mapping to payroll categories, and applicable employment types.
Unique identifier for the work type.
Name of the work type.
External identifier for the work type in the payroll system.
Indicates whether the work type is enabled.
The category type this work type maps to in the payroll system.
Name of the associated pay category in the payroll system.
Name of the associated leave category in the payroll system.
The unit of measurement for the rate (e.g., "hour", "day").
Comma-separated list of employment types this work type applies to.
Current page index
11Number of items per page
20100Total items
Total pages
Example
curl -X GET \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/work_types" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "items": [ { "id": "7daf1397-338c-4b91-9d46-44e6cd56297a", "name": "Ordinary Hours", "external_id": "ORD001", "enable": true, "mapping_type": "PrimaryPayCategory", "pay_category_name": "Ordinary Time", "leave_category_name": null, "rate_unit": "hour", "employment_types": "FullTime,PartTime" } ], "page_index": 1, "item_per_page": 20, "total_items": 1, "total_pages": 1 }}