This deployment guide will stipulate the processes of using the people and jobs endpoints in the API. Specifically, for the use of the POST action to create a person or job. Also included are a few simple ways by which the API can be used to check (via use of the GET action) if a person already exists before proceeding to a create a new person.
Navigation:
Checking if a Person Exists
Before creating a person or job in intelliHR, you should check if a matching person or job record already exists. This can be achieved a number of ways using intelliHR’s public API.
List All People 📄
GET https://api.intellihr.io/v1/people
Using the list all people endpoint, you can iterate through the response to find a match against existing people.
We recommend using the following unique search identifiers:
idemployeeNumberprimaryEmailAddressdisplayName
Using Filters ☑
GET https://api.intellihr.io/v1/people
Alternatively, you may wish to use the provided filters on the List all people endpoint to search for an existing person or job record in intelliHR.
The following filters are available on this endpoint, and all filters below support the equality [eq] operation.
You can add filters by adding the above "Example" strings to your query request, preceded by a ?
For example, to search for an employee by primaryEmailAddress you would perform the following request on the List all people endpoint.
e.g. GET https://api.intellihr.io/v1/people?filters[primaryEmailAddress][eq]=demo@intellihr.com
Find a Person by ID 🔎
GET https://api.intellihr.io/v1/people/{id}
If you already have the person id you can use the Find a Person by ID endpoint to return the person record attached to that id.
e.g. GET https://api.intellihr.io/v1/people/6ced7aed-adeb-4645-896a-5eaa21f4bf6e
Create a Person
POST https://api.intellihr.io/v1/people
Once you have confirmed that the person record does not already exist in intelliHR, you can create a person using the Create a Person endpoint.
Create a Job
Using the person ID, you can then create a job record.
Required field information can be found on the intelliHR API documentation here.