Position

Create Position

Create a new HR position for a work site. The position can be assigned to specific members and teams, and can have a color associated with it for visual identification.

POST

https://api.employmenthero.com/api/v1/organisations/:organisation_id/positions

Path Parameters

organisation_iduuidrequired

The ID of the organisation

Request Body

namestringrequired

The name of the HR position

work_site_iduuidrequired

Unique identifier for an existing work site

cost_centre_iduuidrequired

Unique identifier for an existing cost centre

member_idsuuid[]

Array of unique identifiers for members assigned to this HR position.

team_idsuuid[]

Array of unique identifiers for teams assigned to this HR position.

Note

This field corresponds to 'Groups' in the Employment Hero UI.

team_assign_modeenum<string>

The team assign mode for the HR position

colorenum<string>

The color associated with the HR position.

Response Body

The created position object.

dataobject

iduuid

Unique identifier for the HR position.

statusenum<string>

The status of the HR position.

hr_position_titleobject

The HR position title details.

roster_positions_countnumber

The number of roster positions for this HR position.

cost_centreobject

The cost centre associated with this HR position.

colorenum<string>

The color associated with this HR position.

team_assign_modeenum<string>

The team assign mode of this HR position

member_idsuuid[]

Array of unique identifiers for members assigned to this HR position.

team_idsuuid[]

Array of unique identifiers for teams assigned to this HR position.

Note

This field corresponds to 'Groups' in the Employment Hero UI.

Example

curl -X POST \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/positions" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \  -H "Content-Type: application/json" \  -d '{    "name": "Position",    "work_site_id": "382443a5-f39d-4d55-bf30-1489f7fd6acf",    "cost_centre_id": "0b7ef29a-5172-4437-a6fd-2c9291eb04a9",    "member_ids": [      "fe179bf9-19e3-4779-b458-e2d418127186"    ],    "team_ids": [      "7d5046b1-b63c-427c-bfdd-917f733e8496"    ],    "color": "smalt",    "team_assign_mode": "auto_assign"  }'

Response

{  "data": {    "id": "74aae202-676b-4e8e-8c56-55612ced8e2d",    "status": "active",    "hr_position_title": {      "id": "c44cfdca-7433-46e9-9502-038fa6333dce",      "name": "Position"    },    "roster_positions_count": 5,    "cost_centre": {      "id": "0b7ef29a-5172-4437-a6fd-2c9291eb04a9",      "name": "AU"    },    "color": "smalt",    "team_assign_mode": "auto_assign",    "team_ids": [      "7d5046b1-b63c-427c-bfdd-917f733e8496"    ],    "member_ids": [      "fe179bf9-19e3-4779-b458-e2d418127186"    ]  }}

Update Position

Update an existing HR position. All parameters are optional, allowing you to update only the fields you need.

PATCH

https://api.employmenthero.com/api/v1/organisations/:organisation_id/positions/:position_id

Path Parameters

organisation_iduuidrequired

The ID of the organisation

position_iduuidrequired

The ID of the position

Request Body

namestring

The name of the HR position

cost_centre_iduuid

Unique identifier for an existing cost centre

member_idsuuid[]

Array of unique identifiers for members assigned to this HR position.

team_idsuuid[]

Array of unique identifiers for teams assigned to this HR position.

Note

This field corresponds to 'Groups' in the Employment Hero UI.

team_assign_modeenum<string>

The team assign mode for the HR position

colorenum<string>

The color associated with the HR position.

Response Body

The updated HR position object.

dataobject

iduuid

Unique identifier for the HR position.

statusenum<string>

The status of the HR position.

hr_position_titleobject

The HR position title details.

roster_positions_countnumber

The number of roster positions for this HR position.

cost_centreobject

The cost centre associated with this HR position.

colorenum<string>

The color associated with this HR position.

team_assign_modeenum<string>

The team assign mode of this HR position

member_idsuuid[]

Array of unique identifiers for members assigned to this HR position.

team_idsuuid[]

Array of unique identifiers for teams assigned to this HR position.

Note

This field corresponds to 'Groups' in the Employment Hero UI.

Example

curl -X PATCH \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/positions/:position_id" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \  -H "Content-Type: application/json" \  -d '{    "name": "Updated Position Name",    "cost_centre_id": "0b7ef29a-5172-4437-a6fd-2c9291eb04a9",    "member_ids": [      "fe179bf9-19e3-4779-b458-e2d418127186"    ],    "team_ids": [      "7d5046b1-b63c-427c-bfdd-917f733e8496"    ],    "color": "green",    "team_assign_mode": "auto_assign"  }'

Response

{  "data": {    "id": "74aae202-676b-4e8e-8c56-55612ced8e2d",    "status": "active",    "hr_position_title": {      "id": "c44cfdca-7433-46e9-9502-038fa6333dce",      "name": "Position"    },    "roster_positions_count": 5,    "cost_centre": {      "id": "0b7ef29a-5172-4437-a6fd-2c9291eb04a9",      "name": "AU"    },    "color": "smalt",    "team_assign_mode": "auto_assign",    "team_ids": [      "7d5046b1-b63c-427c-bfdd-917f733e8496"    ],    "member_ids": [      "fe179bf9-19e3-4779-b458-e2d418127186"    ]  }}