Employment HeroTeam
Note
In the Employment Hero UI, "Teams" are displayed as "Groups". The API continues to use "team" terminology in field names and endpoints for backward compatibility.
Returns an array of all teams. Every teams must be managed by one of your managed organisation.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/teamsPath Parameters
The ID of organisation which the all teams belong to
Query Parameters
Current page index
11Number of items per page
20100Response Body
A hash with a data property that contains an array of up to the limit of teams. Each entry in the array is a separate team object. If there are no more teams belonging to your organisation, the resulting array will be empty.
Unique identifier for the object.
The name of the team to retrieve
The status of your team
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/teams" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "items": [ { "id": "143ed07a-e7d1-4c19-ade6-b0ffe9123d19", "name": "Customer Success", "status": "active" }, { "id": "36bd330e-3a6b-4539-8c86-a414fc3b485e", "name": "Engineering", "status": "active" }, { "id": "7a040b66-9bd7-47d4-b6e4-c68ed0931876", "name": "Finance", "status": "active" } ], "page_index": 1, "item_per_page": 20, "total_items": 3, "total_pages": 1 }}Returns an array of employees associated to a specific team. Employees must be managed by your managed organisation.
Similar to Get Employees response.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/teams/:team_id/employeesPath Parameters
The ID of the organisation to get employees
The ID of the team to get employees
Query Parameters
Current page index
11Number of items per page
20100Response Body
A hash with a data property that contains an item array of up to limit employees. Each entry in the array is a separate employee object. If there are no more employees, the resulting array will be empty.
Unique identifier for the object.
The account name of employee
The title of employee
The role of employee
The first name of employee
The last name of employee
The middle name of employee
The address of employee
The avatar url of employee
The preferred name of the employee
The job title of the employee
The gender of the employee
The country of the employee
The date of birth of employee
The marital status of employee
The personal email of employee
The personal mobile number of employee
The home phone of employee
The employing entity of employee
The code of employee
The location of employee
The company email of employee
The company mobile of employee
The company landline of employee
The start date of employee
The termination day of employee
The teams of employee
Note
The primary cost centre of employee
The secondary cost centre of employee
The primary manager of employee
The external id of employee (ID of payroll system)
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/teams/:team_id/employees" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "items": [ { "id": "0139ebb7-6f3e-4bc0-954e-9e50614fccd1", "account_email": "daniel@thinkei.com", "title": "Ms", "role": "owner", "first_name": "Daniel", "last_name": "Tran", "middle_name": "Tuan", "address": "Test Street 184752, Apt 8B, Sydney, NSW, 2000, AU", "avatar_url": "http://avatar.png", "known_as": "Danny", "job_title": "Grad Developer", "gender": "Female", "country": "AU", "date_of_birth": "1995-02-13T00:00:00+00:00", "marital_status": "Single", "personal_email": "abc@thinkei.com", "personal_mobile_number": "01285659993", "home_phone": "02 9123 4567", "employing_entity": "US", "code": "EMP123", "location": null, "company_email": "abc@thinkei.com", "company_mobile": "0412 345 678", "company_landline": "02 8181 1234", "start_date": "2017-03-01T00:00:00+00:00", "termination_date": null, "teams": [ { "id": "95df8139-479f-432e-b8f9-922352123e4a", "name": "Group 1" }, { "id": "95df8139-479f-432e-b8f9-112352123e4a", "name": "Group 2" } ], "primary_cost_centre": { "id": "95df8139-479f-432e-b8f9-922352d2fe4a", "name": "Employment Hero" }, "secondary_cost_centres": [], "primary_manager": { "id": "4a728243-8930-4a93-9bd8-a6843e7b59ec", "name": "Jessica" }, "external_id": "external_id_123" } ], "page_index": 1, "item_per_page": 20, "total_items": 1, "total_pages": 1 }}