Integrate with PageUp's Core HR Role API with your HRIS to create, update and archive Role records.
The Core HR Role API allows you to manipulate roles. The purpose of this API is to provide an endpoint for the consumers to insert a new role or update an existing one. The Role API allows for:
For information on how to obtain API credentials and to start integrating with the Core HR API, please visit the Getting started page.
To begin using any of the Core HR APIs, there are a few things that you will need:
Public.HrCore.Write
in the authentication request. Multiple scopes may be requested by specifying them as space separated list. The available scope for the endpoints in this page is
Public.HrCore.Write
Here are some examples on how to create and update Roles using the Core HR Role API. Please note that the Role ID (externalId
) field is mandatory for all requests, however there are certain fields that are mandatory based on the action that you are trying to perform. More details on these fields are available in the following sections.
To create a role record, follow the example provided below. The fields that are required to create a role record are externalId
and name
.
Other fields provided in the example below are optional. The consumer will be provided with a validation message in response if there are any required fields missing.
For a full list of what fields are available and to also view details on requests and all types of responses, please refer to the API specifications below.
PUT /hrcore/role
{
"externalId": "13456",
"title": "Account Executive",
"archive": false,
"indicatorItemTypeExternalId": "CL1002",
"reviewsExternalId": "1111",
"roleTypeExternalId": "JF1001"
}
To update a role record, follow the example provided below. The fields that are required to update a role are externalId
and at least one additional field that needs to be updated. Other fields provided in the example below are optional. The consumer will be provided with a validation message in response if there are any required fields missing.
If any of the fields are not provided they will not be modified however if you intend to delete a field from the record then pass that field as a null
value this will trigger the field to be removed from the system.
For a full list of what fields are available and to also view details on requests and all types of responses, please refer to the API specifications below.
PUT /hrcore/role
{
"externalId": "13456",
"title": "Software Engineer"
}
To archive a role, follow the example provided below. The fields that are required to archive a role are externalId
and archive
. The consumer will be provided with a validation message in response if there are any required fields missing.
For a full list of what fields are available and to also view details on requests and all types of responses, please refer to the API specifications below.
PUT /hrcore/role
{
"externalId": "13456",
"archive": true
}
When integrating with the Core HR API, you may receive validation messages in your responses. Each specific Core HR API resource documents the list of validation messages you may receive and what they mean.
In addition to validation messages, you may also receive generic HTTP Status code error messages in your responses. Information on these error messages can be found on our Error handling page.
Root url:
https://<environment>.<dataCentreId>.pageuppeople.com/v3/<tenantId>/hrcore/...
Where
environment = specify 'api' for production or 'apiuat' for development or testing
dataCentreId = the data centre to connect to (e.g. dc2)
tenantId = the organisation's tenant Id (e.g. 218)
Region | dataCentreId |
---|---|
AUS | dc2 |
UK / EMEA | dc3 |
US | dc4 |
SEA | dc5 |
Please contact PageUp representative to find out the data centre and organisation's tenant Id if not known.
Example - connect to the 218 production environment on dc2
https://api.dc2.pageuppeople.com/v3/218/hrcore/role
Example - connect to the 218 development or testing environment on dc2
https://apiuat.dc2.pageuppeople.com/v3/218/hrcore/role
The Postman collection is available publicly (Core HR API > Role API): Role API