intelliHR (Preview)

intelliHR is a cloud-based people management platform with advanced analytics capabilities. Connect to your intelliHR tenant to automate people-oriented workflows (such as onboarding) and data export.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Customer Support
URL https://intellihr.zendesk.com/hc/en-us
Email support@intellihr.co
Connector Metadata
Publisher intelliHR
Website https://www.intellihr.com
Privacy policy https://intellihr.co/privacy-policy/
Categories Human Resources;Business Intelligence

intelliHR is an easy-to-use People Management and Analytics platform for centralized performance management, employee engagement, core Human Resources processes and HR analytics all in the one place. Create scheduled tasks and automated workflows with your people data in Power Automate, Office 365, SharePoint, Microsoft Dynamics 365, and other services without code with the intelliHR Connector.

Prerequisites

In order to use this connector, you must have an intelliHR tenant. To have a tenant provisioned for your group or organisation, please visit this page.

How to get credentials

To configure the connector, you will need an API key and your tenant name.

Your tenant name will correspond to your account subdomain (eg. https://this-is-your-tenant-name.intellihr.net).

To create an API key:

  1. Log in to your tenant with an administrator account
  2. Navigate to the Settings page
  3. Search for 'API', and click on 'Public API Access Keys'
  4. Follow the prompts on this page to create a key.

You can also find the correct interface at https://your-tenant.intellihr.net/spa/settings/access-keys

Getting started with your connector

When adding the intelliHR connector, you will be prompted to input your tenant name and API key, as well as a display name for the connection.

Important: When inputting your API key, make sure to prepend the key with 'Bearer ', such that the input should read 'Bearer xyz123'. Failure to do so will result in 'Invalid API key' errors.

Known issues and limitations

The intelliHR connector is a translation of intelliHR's public API and as such it inherits the same limitations and requires the same validation on requests.

Common errors and remedies

As the intelliHR connector passes requests to intelliHR's public API, most issues can be troubleshot by referencing the public API documentation.

A 400-range error is returned if some part of the request is inappropriate, and will be accompanied by a message describing the problem. The most common issue is that the connector has been configured without 'Bearer ' in the API key input.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api, prepended with 'Bearer ' True
Tenant string Your intelliHR tenant name True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Create a new Business Unit

Returns the created Business Unit.

Create a new Job

Create a new Job record with the provided data.

Create a new person record

Create a person

Create a presigned upload URL

Create a presigned upload URL

Create a Training record

Create a new Training record

Delete a Business Unit by ID

Delete a Business Unit by the given ID.

Delete a Training record by ID

Deletes the provided Training record.

Delete a Webhook by ID

Deletes the provided webhook.

Find a Business Entity by ID

Returns a single Business Entity by its identifier.

Find a Business Unit by ID

Returns a single Business Unit.

Find a Custom Field Definition by ID

Returns a single Custom Field Definition.

Find a Default Remuneration Component by ID

Returns a single default remuneration component.

Find a Job by ID

Get a single Job record by UUIDv4 identifier.

Find a Location by ID

Returns a single location.

Find a Pay Grade by ID

Returns a single pay grade.

Find a Person by ID

Get a single Person record by UUIDv4 identifier.

Find a Recruitment Source by ID

Returns a single recruitment source.

Find a Training Provider by ID

Returns a single Training Provider.

Find a Training record by ID

Returns a single Training record.

Find a Training Type by ID

Returns a single Training Type.

Find a Webhook by ID

Returns a single webhook.

Find a Webhook Event by ID

Returns a single Webhook Event.

Find a Work Class by ID

Returns a single work class.

Find a Work Right by ID

Returns a single work right.

Find a Work Type by ID

Returns a single work type.

Find an Employment Condition by ID

Returns a single employment condition.

List all Business Entities

Returns a list of all Business Entities.

List all Business Units

Returns a list of all Business Units recorded in the system.

List all Custom Field Definitions

Returns a list of all Custom Field Definitions.

List all Default Remuneration Components

Returns a list of all Default Remuneration Components recorded in the system.

List all employment conditions

Returns a list of all employment conditions.

List all Jobs

Returns a list of all Job entity records as at the current date.

List all locations

Returns a list of all locations.

List all pay grades

Returns a list of all pay grades.

List all people

Returns a list of all People as at the current date.

List all recruitment sources

Returns a list of all recruitment sources.

List all Training Providers

Returns a list of all Training Providers.

List all Training Types

Returns a list of all Training Types.

List all Trainings

Returns a list of all Training records.

List all work classes

Returns a list of all Work Classes recorded in the system.

List all Work Rights

Returns a list of all Work Rights recorded in the system.

List all Work Types

Returns a list of all Work Types recorded in the system.

Patch an existing Job

Patch attributes of an existing Job record with the provided data.

Set the end date for a job

Set the end date for a job

Update a Business Unit by ID

Returns the updated Business Unit.

Update a document by id

Update a Document

Update a Person by ID

Update a person

Update a Training record by ID

Update a Training record

UpdateAWebhook

Patch a Webhook

Create a new Business Unit

Returns the created Business Unit.

Parameters

Name Key Required Type Description
identifier
identifier string

Optional identifier that can be used for administrative tasks.

name
name True string

Name given to this Business Unit. This name would normally be shown to users of the system.

notes
notes string

Notes attached to a Business Unit

parentId
parentId string

The identifier string for the parent Business Unit, or null if there is no parent (this is a top level business unit).

isEnabled
isEnabled boolean

Specifies whether users can select this Business Unit in dropdowns.

Returns

Response
Response

Create a new Job

Create a new Job record with the provided data.

Parameters

Name Key Required Type Description
id
id string

The identifier string for the Person to locate in the system.

name
name string

The name of the Person in intelliHR to search for. Note that the search accounts for differences in name order automatically.

primaryEmailAddress
primaryEmailAddress string

The email address flagged as primary for the Person within the system.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId string

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

companyStartDate
companyStartDate True string

The date this Job started or will start within the organisation. This date will follow the format defined by RFC3339.

YYYY-MM-DD date formatting is also supported, although by using this format the date will be stored as the start of day in UTC time, not the requesting tenants timezone.

companyEndDate
companyEndDate string

The date this Job ended or will end within the organisation. This date will follow the format defined by RFC3339.

YYYY-MM-DD date formatting is also supported, although by using this format the date will be stored as the start of day in UTC time, not the requesting tenants timezone.

name
name True string

The job name to be created

id
id string

The identifier string for the Business Entity to whom this Job belongs.

name
name string

Name given to this Business Entity. This name would normally be shown to users of the system.

legalName
legalName string

Legal name of Business Entity. Usually used for administrative tasks.

number
number string

Legally registered Business Entity number, e.g. in Australia this might be the ABN, or in America the RN.

id
id string

The identifier string for the Business Unit to whom this Job belongs.

name
name string

Name given to this Business Unit. This name would normally be shown to users of the system.

id
id string

The identifier string for the Person to locate in the system.

name
name string

The name of the Person in intelliHR to search for. Note that the search accounts for differences in name order automatically.

primaryEmailAddress
primaryEmailAddress string

The email address flagged as primary for the Person within the system.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId string

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

id
id string

The identifier string for the Supervisor's Job of this Job.

name
name string

The name/position title of the Supervisor's Job.

id
id string

The identifier string for the Location.

name
name string

Name given to this Location. This name would normally be shown to users of the system.

address
address string

The address of this location.

id
id string

The identifier string for the Work Class to whom this Job belongs.

name
name string

The name of the Work Class.

id
id string

The identifier string for the Work Type to whom this Job belongs.

name
name string

The name of the Work Type. Enum: Permanent, Fixed Contract, Unpaid, Temporary/Casual, Independent Contract.

fte
fte string

The full time equivalent of this Job. Indicating the workload of an employee that can be comparable across different contexts. This is null for people without an FTE.

id
id string

The identifier string for the Pay Grade.

code
code string

Administrative, short code associated to the Pay Grade.

name
name string

User friendly name given to the Pay Grade.

type
type string

The method in which this remuneration schedule is paid. Enum: Annual Salary, Hourly Rate, No Remuneration Schedule.

payCycle
payCycle True string

The cycle that the job is paid on. Enum: Weekly, Fortnightly, Monthly.

currency
currency string

The currency that the base and total amounts that this job is being paid in. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

id
id string

The identifier string for the Employment Condition of this Remuneration Schedule.

name
name string

Name given to this Employment Condition.

awardName
awardName string

Award name can be different from the name presented to a user. Usually used for the legal name of the award.

hoursPerCycle
hoursPerCycle True double

How many hours worked per payCycle.

baseAnnualSalary
baseAnnualSalary double

The Base Salary paid yearly, this is only required if the Remuneration Schedule Type is "Annual Salary".

baseHourlyRate
baseHourlyRate double

The Base Rate paid hourly, this is only required if the Remuneration Schedule Type is "Hourly Rate".

name
name True string

The name of this Addition.

type
type True string

How this addition is calculated and applied to the base amount, MultipleOfBase is multiplied by baseAnnualSalary and then added to the total while FixedAmount is added directly to the total. Enum: MultipleOfBase, FixedAmount.

value
value True string

For MultipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this Addition. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

id
id string

The identifier string for the default remuneration component.

name
name string

Name of the default remuneration component.

name
name True string

The name of this Addition.

type
type True string

How this addition is calculated and applied to the base amount, MultipleOfBase is multiplied by baseAnnualSalary and then added to the total while FixedAmount is added directly to the total. Enum: MultipleOfBase, FixedAmount.

value
value True string

For MultipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this Addition. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

name
name True string

The name of this Breakdowns.

type
type True string

How this breakdown is calculated and applied to the base amount, MultipleOfBase is multiplied by baseAnnualSalary and then added to the total while FixedAmount is added directly to the total. Enum: MultipleOfBase, FixedAmount.

value
value True string

For MultipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this breakdown. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

id
id string

The identifier string for the default remuneration component.

name
name string

Name of the default remuneration component.

id
id string

The identifier string for the Recruitment Source.

name
name string

The name given to this recruitment source.

cost
cost double

The cost of the recruitment.

currency
currency string

The currency used to recruit this Job. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

Returns

SingleJob
SingleJob

Create a new person record

Create a person

Parameters

Name Key Required Type Description
firstName
firstName string

The Person's First Name.

middleName
middleName string

The Person's Middle Name.

lastName
lastName True string

The Person's Last Name.

preferredName
preferredName string

The Person's Preferred Name. Can generally be configured by employees for themselves.

dateOfBirth
dateOfBirth string

Date of Birth (YYYY-MM-DD).

gender
gender string

Human readable string for the Person's gender, e.g. Male. Searching is done case-insensitively and 'starts-with' e.g. passing male will match with a Gender called "Male" as will "m" or "M". If multiple Genders match the first will be chosen.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

title
title string

The title to refer to this Person as, for example "Mr". This is null if not provided and is case insensitive.

name
name string

The name of the emergency contact.

relationship
relationship string

The relationship this emergency contact has with the Person.

phone
phone string

Phone number of the emergency contact.

email
email string

Email of the emergency contact.

email
email string

The actual email address.

isPersonal
isPersonal boolean

Denotes whether this email is personal or a work email.

number
number string

The actual phone number. This number can be prefixed with an area code. When this happens, the system will automatically try to determine the origin country for the phone number

isPersonal
isPersonal boolean

Denotes whether this phone is personal or a work phone number.

id
id string

The identifier string for the Work Right to whom this Person belongs.

name
name string

The name of the Work Right.

workRightExpiryDate
workRightExpiryDate string

The date this Work Right will expire for this Person (YYYY-MM-DD).

Returns

SinglePerson
SinglePerson

Create a presigned upload URL

Create a presigned upload URL

Parameters

Name Key Required Type Description
id
id string

The identifier string for the Person to locate in the system.

name
name string

The name of the Person in intelliHR to search for. Note that the search accounts for differences in name order automatically.

primaryEmailAddress
primaryEmailAddress string

The email address flagged as primary for the Person within the system.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId string

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

filename
filename True string

The original filename of the document. This will be used for display name. Includes extension.

mime
mime True string

The mime type of the document

size
size True integer

The estimated size of the document in bytes

extension
extension True string

The extension of the document, not including the dot

Returns

SinglePersonDocument
SinglePersonDocument

Create a Training record

Create a new Training record

Parameters

Name Key Required Type Description
id
id string

The identifier string for the Person to locate in the system.

name
name string

The name of the Person in intelliHR to search for. Note that the search accounts for differences in name order automatically.

primaryEmailAddress
primaryEmailAddress string

The email address flagged as primary for the Person within the system.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId string

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

completionDate
completionDate True string

The timestamp the Training was completed. This date will follow the format defined by RFC3339.

YYYY-MM-DD date formatting is also supported, although by using this format the date will be stored as the start of day in UTC time, not the requesting tenants timezone.

cost
cost string

The cost of this Training.

currency
currency string

The currency used for this Training. Will default to the tenant default currency when not provided. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

hours
hours string

How many hours were spent on this Training

id
id string

The identifier string for the Job that this Training was completed for.

name
name True string

User friendly name given to this Training to identify it in the system.

id
id string

The identifier string for the Person to locate in the system.

name
name string

The name of the Person in intelliHR to search for. Note that the search accounts for differences in name order automatically.

primaryEmailAddress
primaryEmailAddress string

The email address flagged as primary for the Person within the system.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId string

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

id
id string

The identifier string for the Training Provider of the Training.

name
name string

User friendly name given to the Training Provider of the Training.

id
id string

The identifier string for the Training Type of the Training.

name
name string

User friendly name given to the Training Type of the Training.

customFields
customFields

The custom field values for this Training

Returns

SingleTraining
SingleTraining

Delete a Business Unit by ID

Delete a Business Unit by the given ID.

Parameters

Name Key Required Type Description
The ID of the business unit
id True string

The resource identifier string

Returns

response
string

Delete a Training record by ID

Deletes the provided Training record.

Parameters

Name Key Required Type Description
The ID of the training record
id True string

The resource identifier string

Returns

response
string

Delete a Webhook by ID

Deletes the provided webhook.

Parameters

Name Key Required Type Description
The ID of the webhook
id True string

The resource identifier string

Returns

response
string

Find a Business Entity by ID

Returns a single Business Entity by its identifier.

Parameters

Name Key Required Type Description
The resource identifier string
id True string

The resource identifier string

Returns

SingleBusinessEntity
SingleBusinessEntity

Find a Business Unit by ID

Returns a single Business Unit.

Parameters

Name Key Required Type Description
The ID of the business unit
id True string

The resource identifier string

Returns

Response
Response

Find a Custom Field Definition by ID

Returns a single Custom Field Definition.

Parameters

Name Key Required Type Description
The ID of the custom field
id True string

The resource identifier string

Returns

SingleCustomFieldDefinition
SingleCustomFieldDefinition

Find a Default Remuneration Component by ID

Returns a single default remuneration component.

Parameters

Name Key Required Type Description
The remuneration component ID
id True string

The resource identifier string

Returns

SingleDefaultRemunerationComponent
SingleDefaultRemunerationComponent

Find a Job by ID

Get a single Job record by UUIDv4 identifier.

Parameters

Name Key Required Type Description
The ID of the job to return
id True string

The resource identifier string

Return data accurate for the job at this date
asAt string

Used to configure what date to return this job data for, as a RFC3339 datetime.

All data returned from the job endpoints represent the values of the Person's job attributes at a specific point in time.

By default, the current datetime is used, but this parameter can be used to configure a different datetime to see historical data.

Returns

SingleJob
SingleJob

Find a Location by ID

Returns a single location.

Parameters

Name Key Required Type Description
The ID of the location
id True string

The resource identifier string

Returns

SingleLocation
SingleLocation

Find a Pay Grade by ID

Returns a single pay grade.

Parameters

Name Key Required Type Description
The ID of the pay grade
id True string

The resource identifier string

Returns

SinglePayGrade
SinglePayGrade

Find a Person by ID

Get a single Person record by UUIDv4 identifier.

Parameters

Name Key Required Type Description
The ID of the person record
id True string

The ID of the person record

Returns

SinglePerson
SinglePerson

Find a Recruitment Source by ID

Returns a single recruitment source.

Parameters

Name Key Required Type Description
The ID of the recruitment source
id True string

The resource identifier string

Returns

SingleRecruitmentSource
SingleRecruitmentSource

Find a Training Provider by ID

Returns a single Training Provider.

Parameters

Name Key Required Type Description
The ID of the training provider
id True string

The resource identifier string

Returns

SingleTrainingProvider
SingleTrainingProvider

Find a Training record by ID

Returns a single Training record.

Parameters

Name Key Required Type Description
The ID of the training record
id True string

The resource identifier string

Returns

SingleTraining
SingleTraining

Find a Training Type by ID

Returns a single Training Type.

Parameters

Name Key Required Type Description
The training type ID
id True string

The resource identifier string

Returns

SingleTrainingTypes
SingleTrainingTypes

Find a Webhook by ID

Returns a single webhook.

Parameters

Name Key Required Type Description
The ID of the webhook
id True string

The resource identifier string

Returns

SingleWebhook
SingleWebhook

Find a Webhook Event by ID

Returns a single Webhook Event.

Parameters

Name Key Required Type Description
The ID of the webhook event
id True string

The resource identifier string

Returns

Single Webhook Event.

webhook-events
webhook-events

Find a Work Class by ID

Returns a single work class.

Parameters

Name Key Required Type Description
The ID of the work class
id True string

The resource identifier string

Returns

SingleWorkClass
SingleWorkClass

Find a Work Right by ID

Returns a single work right.

Parameters

Name Key Required Type Description
The ID of the work right
id True string

The resource identifier string

Returns

SingleWorkRight
SingleWorkRight

Find a Work Type by ID

Returns a single work type.

Parameters

Name Key Required Type Description
The ID of the work type
id True string

The resource identifier string

Returns

SingleWorkType
SingleWorkType

Find an Employment Condition by ID

Returns a single employment condition.

Parameters

Name Key Required Type Description
The employment condition ID
id True string

The resource identifier string

Returns

SingleEmploymentCondition
SingleEmploymentCondition

List all Business Entities

Returns a list of all Business Entities.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListofBusinessEntities
ListofBusinessEntities

List all Business Units

Returns a list of all Business Units recorded in the system.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListofBusinessUnits
ListofBusinessUnits

List all Custom Field Definitions

Returns a list of all Custom Field Definitions.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Filters to apply to the query
filters string

Filters can be applied in the query string to limit the data returned from this endpoint. Filters are provided in the format filters[<filter_name>][<operation_type>]=<filter_value>. For example, a filter to get items matching a specific ID would be filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9.

Returns

ListofCustomFieldDefinitions
ListofCustomFieldDefinitions

List all Default Remuneration Components

Returns a list of all Default Remuneration Components recorded in the system.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListofDefaultRemunerationComponents
ListofDefaultRemunerationComponents

List all employment conditions

Returns a list of all employment conditions.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListofEmploymentConditions
ListofEmploymentConditions

List all Jobs

Returns a list of all Job entity records as at the current date.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Filters to apply to the query
filters string

Filters can be applied in the query string to limit the data returned from this endpoint. Filters are provided in the format filters[<filter_name>][<operation_type>]=<filter_value>. For example, a filter to get items matching a specific ID would be filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9.

Sorting order to apply to the query
sort string

Sorting can be applied in the query string to order the data returned from this endpoint. Sort can be prepended with a minus to return the data in descending (-) order. For example, a sort to get the most recent records first would be -createdAt.

Returns

ListJobs
ListJobs

List all locations

Returns a list of all locations.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

Listlocations
Listlocations

List all pay grades

Returns a list of all pay grades.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListofPayGrades
ListofPayGrades

List all people

Returns a list of all People as at the current date.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Filters to apply to the query
filters string

Filters can be applied in the query string to limit the data returned from this endpoint. Filters are provided in the format filters[<filter_name>][<operation_type>]=<filter_value>. For example, a filter to get items matching a specific ID would be filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9.

Sorting order to apply to the query
sort string

Sorting can be applied in the query string to order the data returned from this endpoint. Sort can be prepended with a minus to return the data in descending (-) order. For example, a sort to get the most recent records first would be -createdAt.

Returns

ListPeople
ListPeople

List all recruitment sources

Returns a list of all recruitment sources.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListofRecruitmentSources
ListofRecruitmentSources

List all Training Providers

Returns a list of all Training Providers.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListallTrainingProviders
ListallTrainingProviders

List all Training Types

Returns a list of all Training Types.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListallTrainingTypes
ListallTrainingTypes

List all Trainings

Returns a list of all Training records.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Filters to apply to the query
filters string

Filters can be applied in the query string to limit the data returned from this endpoint. Filters are provided in the format filters[<filter_name>][<operation_type>]=<filter_value>. For example, a filter to get items matching a specific ID would be filters[id][eq]=8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9.

Sorting order to apply to the query
sort string

Sorting can be applied in the query string to order the data returned from this endpoint. Sort can be prepended with a minus to return the data in descending (-) order. For example, a sort to get the most recent records first would be -createdAt.

Returns

ListofTrainings
ListofTrainings

List all work classes

Returns a list of all Work Classes recorded in the system.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListWorkClasses
ListWorkClasses

List all Work Rights

Returns a list of all Work Rights recorded in the system.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListofWorkRights
ListofWorkRights

List all Work Types

Returns a list of all Work Types recorded in the system.

Parameters

Name Key Required Type Description
The number of items per page
limit integer

The number of items per page

The page number
page integer

The page number

Returns

ListWorkTypes
ListWorkTypes

Patch an existing Job

Patch attributes of an existing Job record with the provided data.

Parameters

Name Key Required Type Description
The ID of the job
id True string

The resource identifier string

effectiveFrom
effectiveFrom True string

The date this Job Update is effective from within the organisation. Note that this doesn't affect the start date of the overall job itself. A null value will indicate that this Update is effective from the start of the Job. This date will follow the format defined by RFC3339.

YYYY-MM-DD date formatting is also supported, although by using this format the date will be stored as the start of day in UTC time, not the requesting tenants timezone.

effectiveTo
effectiveTo string

The date this Job Update is effective to within the organisation. Note that this doesn't affect the end date of the overall job itself. This date will follow the format defined by RFC3339.

YYYY-MM-DD date formatting is also supported, although by using this format the date will be stored as the start of day in UTC time, not the requesting tenants timezone.

name
name string

The job name to be updated

id
id string

The identifier string for the Business Entity to whom this Job belongs.

name
name string

Name given to this Business Entity. This name would normally be shown to users of the system.

legalName
legalName string

Legal name of Business Entity. Usually used for administrative tasks.

number
number string

Legally registered Business Entity number, e.g. in Australia this might be the ABN, or in America the RN.

id
id string

The identifier string for the Business Unit to whom this Job belongs.

name
name string

Name given to this Business Unit. This name would normally be shown to users of the system.

id
id string

The identifier string for the Person to locate in the system.

name
name string

The name of the Person in intelliHR to search for. Note that the search accounts for differences in name order automatically.

primaryEmailAddress
primaryEmailAddress string

The email address flagged as primary for the Person within the system.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId string

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

id
id string

The identifier string for the Supervisor's Job of this Job.

name
name string

The name/position title of the Supervisor's Job.

id
id string

The identifier string for the Location.

name
name string

Name given to this Location. This name would normally be shown to users of the system.

address
address string

The address of this location.

id
id string

The identifier string for the Work Class to whom this Job belongs.

name
name string

The name of the Work Class.

id
id string

The identifier string for the Work Type to whom this Job belongs.

name
name string

The name of the Work Type. Enum: Permanent, Fixed Contract, Unpaid, Temporary/Casual, Independent Contract.

fte
fte string

The full time equivalent of this Job. Indicating the workload of an employee that can be comparable across different contexts. This is null for people without an FTE.

id
id string

The identifier string for the Pay Grade.

code
code string

Administrative, short code associated to the Pay Grade.

name
name string

User friendly name given to the Pay Grade.

type
type string

The method in which this remuneration schedule is paid. Enum: Annual Salary, Hourly Rate, No Remuneration Schedule.

payCycle
payCycle True string

The cycle that the job is paid on. Enum: Weekly, Fortnightly, Monthly.

currency
currency string

The currency that the base and total amounts that this job is being paid in. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

id
id string

The identifier string for the Employment Condition of this Remuneration Schedule.

name
name string

Name given to this Employment Condition.

awardName
awardName string

Award name can be different from the name presented to a user. Usually used for the legal name of the award.

hoursPerCycle
hoursPerCycle True double

How many hours worked per payCycle.

baseAnnualSalary
baseAnnualSalary double

The Base Salary paid yearly, this is only required if the Remuneration Schedule Type is "Annual Salary".

baseHourlyRate
baseHourlyRate double

The Base Rate paid hourly, this is only required if the Remuneration Schedule Type is "Hourly Rate".

name
name True string

The name of this Addition.

type
type True string

How this addition is calculated and applied to the base amount, MultipleOfBase is multiplied by baseAnnualSalary and then added to the total while FixedAmount is added directly to the total. Enum: MultipleOfBase, FixedAmount.

value
value True string

For MultipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this Addition. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

id
id string

The identifier string for the default remuneration component.

name
name string

Name of the default remuneration component.

name
name True string

The name of this Addition.

type
type True string

How this addition is calculated and applied to the base amount, MultipleOfBase is multiplied by baseAnnualSalary and then added to the total while FixedAmount is added directly to the total. Enum: MultipleOfBase, FixedAmount.

value
value True string

For MultipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this Addition. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

name
name True string

The name of this Breakdowns.

type
type True string

How this breakdown is calculated and applied to the base amount, MultipleOfBase is multiplied by baseAnnualSalary and then added to the total while FixedAmount is added directly to the total. Enum: MultipleOfBase, FixedAmount.

value
value True string

For MultipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this breakdown. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

id
id string

The identifier string for the default remuneration component.

name
name string

Name of the default remuneration component.

Returns

SingleJob
SingleJob

Set the end date for a job

Set the end date for a job

Parameters

Name Key Required Type Description
The ID of the job to end
id True string

The ID of the job to end

endDate
endDate True string

endDate

turnoverType
turnoverType True string

turnoverType

turnoverReason
turnoverReason string

turnoverReason

Returns

SingleJob
SingleJob

Update a Business Unit by ID

Returns the updated Business Unit.

Parameters

Name Key Required Type Description
The ID of the business unit
id True string

The resource identifier string

identifier
identifier string

Optional identifier that can be used for administrative tasks.

name
name True string

Name given to this Business Unit. This name would normally be shown to users of the system.

notes
notes string

Notes attached to a Business Unit

parentId
parentId string

The identifier string for the parent Business Unit, or null if there is no parent (this is a top level business unit).

isEnabled
isEnabled boolean

Specifies whether users can select this Business Unit in dropdowns.

Returns

Response
Response

Update a document by id

Update a Document

Parameters

Name Key Required Type Description
The ID of the document
id True string

The resource identifier string

personId
personId True string

The identifier string for the Person to whom this Document belongs.

uploadStatus
uploadStatus True string

The upload status of this Document. Enum: SUCCESS, PENDING, FAILED.

Returns

PatchaPersonDocument
PatchaPersonDocument

Update a Person by ID

Update a person

Parameters

Name Key Required Type Description
The ID of the person record
id True string

The resource identifier string

firstName
firstName string

The Person's First Name.

middleName
middleName string

The Person's Middle Name.

lastName
lastName string

The Person's Last Name.

preferredName
preferredName string

The Person's Preferred Name. Can generally be configured by employees for themselves.

dateOfBirth
dateOfBirth string

Date of Birth (YYYY-MM-DD).

gender
gender string

Human readable string for the Person's gender, e.g. Male. Searching is done case-insensitively and 'starts-with' e.g. passing male will match with a Gender called "Male" as will "m" or "M". If multiple Genders match the first will be chosen.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

title
title string

The title to refer to this Person as, for example "Mr". This is null if not provided and is case insensitive.

name
name string

The name of the emergency contact.

relationship
relationship string

The relationship this emergency contact has with the Person.

phone
phone string

Phone number of the emergency contact.

email
email string

Email of the emergency contact.

email
email string

The email address associated with this person.

isPersonal
isPersonal boolean

Denotes whether this email is personal or a work email.

isPrimary
isPrimary boolean

Denotes whether this email is the primary contact email.

number
number string

The phone number. This number can be prefixed with an area code. When this happens, the system will automatically try to determine the origin country for the phone number

isPersonal
isPersonal boolean

Denotes whether this phone is personal or a work phone number.

isPrimary
isPrimary boolean

Denotes whether this phone is the primary contact phone number.

addressType
addressType string

Enum: Home, Postal. The type of address.

fullAddress
fullAddress string

The full readable address, minus the postcode and country

country
country string

The country the address is in.

postcode
postcode string

The postcode of the address.

state
state string

The state the address is in. This is australia-specific and may not always be provided.

street
street string

The street the address is on. This is australia-specific and may not always be provided.

suburb
suburb string

The suburb the address is in. This is australia-specific and may not always be provided.

id
id string

The identifier string for the Work Right to whom this Person belongs.

name
name string

The name of the Work Right.

workRightExpiryDate
workRightExpiryDate string

The date this Work Right will expire for this Person (YYYY-MM-DD).

Returns

SinglePerson
SinglePerson

Update a Training record by ID

Update a Training record

Parameters

Name Key Required Type Description
The ID of the training record
id True string

The resource identifier string

id
id string

The identifier string for the Person to locate in the system.

name
name string

The name of the Person in intelliHR to search for. Note that the search accounts for differences in name order automatically.

primaryEmailAddress
primaryEmailAddress string

The email address flagged as primary for the Person within the system.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId string

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

completionDate
completionDate string

The timestamp the Training was completed. This date will follow the format defined by RFC3339.

YYYY-MM-DD date formatting is also supported, although by using this format the date will be stored as the start of day in UTC time, not the requesting tenants timezone.

cost
cost string

The cost of this Training.

currency
currency string

The currency used for this Training. Will default to the tenant default currency when not provided. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

hours
hours string

How many hours were spent on this Training

id
id string

The identifier string for the Job that this Training was completed for.

name
name string

User friendly name given to this Training to identify it in the system.

id
id string

The identifier string for the Person to locate in the system.

name
name string

The name of the Person in intelliHR to search for. Note that the search accounts for differences in name order automatically.

primaryEmailAddress
primaryEmailAddress string

The email address flagged as primary for the Person within the system.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId string

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

id
id string

The identifier string for the Training Provider of the Training.

name
name string

User friendly name given to the Training Provider of the Training.

id
id string

The identifier string for the Training Type of the Training.

name
name string

User friendly name given to the Training Type of the Training.

customFields
customFields

The custom field values for this Training

Returns

SingleTraining
SingleTraining

UpdateAWebhook

Patch a Webhook

Parameters

Name Key Required Type Description
The ID of the webhook
id True string

The resource identifier string

url
url string

The Webhook endpoint which the request will be sent to when the subscribed Webhook Event is triggered.

webhookEvent
webhookEvent string

The slug of the Webhook Event.

isEnabled
isEnabled boolean

Specifies whether users can select this Webhook. When disabled, this Webhook will not be sent.

source
source string

A customizable string which can be used to identify what system created this Webhook. Webhooks created through the intelliHR application will have source: 'custom'.

Returns

SingleWebhook
SingleWebhook

Triggers

Create a webhook and subscribe to a type of event in your tenant

Create a webhook and subscribe to a type of event in your tenant

Create a webhook and subscribe to a type of event in your tenant

Create a webhook and subscribe to a type of event in your tenant

Parameters

Name Key Required Type Description
webhookEvent
webhookEvent True string

webhookEvent

isEnabled
isEnabled boolean

isEnabled

source
source string

source

Returns

Name Path Type Description
id
id string

id

event
event string

event

timestamp
timestamp string

timestamp

self
links.self string

self

Definitions

SingleBusinessEntity

Name Path Type Description
BusinessEntity
data BusinessEntity

ListofBusinessEntities

Name Path Type Description
data
data array of BusinessEntity
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

Response

Name Path Type Description
BusinessUnit3
data BusinessUnit3
Meta1
meta Meta1

Contains miscellaneous meta information about the response.

ListofBusinessUnits

Name Path Type Description
data
data array of BusinessUnit3
Meta2
meta Meta2

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleCustomFieldDefinition

Name Path Type Description
CustomFieldDefinition
data CustomFieldDefinition

ListofCustomFieldDefinitions

Name Path Type Description
data
data array of CustomFieldDefinition
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleDefaultRemunerationComponent

Name Path Type Description
DefaultRemunerationComponent
data DefaultRemunerationComponent

ListofDefaultRemunerationComponents

Name Path Type Description
data
data array of DefaultRemunerationComponent
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleEmploymentCondition

Name Path Type Description
EmploymentCondition
data EmploymentCondition

ListofEmploymentConditions

Name Path Type Description
data
data array of EmploymentCondition
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleJob

Name Path Type Description
Meta1
meta Meta1

Contains miscellaneous meta information about the response.

Job
data Job

ListJobs

Name Path Type Description
data
data array of Job
Meta8
meta Meta8

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleLocation

Name Path Type Description
location5
data location5

Listlocations

Name Path Type Description
data
data array of location5
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SinglePayGrade

Name Path Type Description
payGrade5
data payGrade5

ListofPayGrades

Name Path Type Description
data
data array of payGrade5
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

ListPeople

Name Path Type Description
data
data array of data1
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SinglePerson

Name Path Type Description
data1
data data1

SinglePersonDocument

Name Path Type Description
Data3
data Data3

PatchaPersonDocument

Name Path Type Description
Data4
data Data4

SingleRecruitmentSource

Name Path Type Description
recruitmentSource
data recruitmentSource

ListofRecruitmentSources

Name Path Type Description
data
data array of recruitmentSource

Recruitment source details.

Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleTrainingProvider

Name Path Type Description
trainingProviders
data trainingProviders

ListallTrainingProviders

Name Path Type Description
data
data array of trainingProviders
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleTraining

Name Path Type Description
Training
data Training

ListofTrainings

Name Path Type Description
data
data array of Training
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleTrainingTypes

Name Path Type Description
trainingTypes
data trainingTypes

ListallTrainingTypes

Name Path Type Description
data
data array of trainingTypes
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleWorkClass

Name Path Type Description
WorkClassesSchema
data WorkClassesSchema

ListWorkClasses

Name Path Type Description
data
data array of WorkClassesSchema
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleWorkRight

Name Path Type Description
WorkRight2
data WorkRight2

ListofWorkRights

Name Path Type Description
data
data array of WorkRight2
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

SingleWorkType

Name Path Type Description
workType4
data workType4

ListWorkTypes

Name Path Type Description
data
data array of workType4
Meta
meta Meta

Contains miscellaneous meta information about the response.

Links
links Links

Links to other related resources.

webhook-events

Single Webhook Event.

Name Path Type Description
Data5
data Data5

SingleWebhook

Name Path Type Description
Data7
data Data7

Addition

Name Path Type Description
name
name string

The name of this Addition.

type
type string

How this addition is calculated and applied to the base amount, multipleOfBase is multiplied by baseAnnualSalary and then added to the total while fixed amount is added directly to the total. Enum: MultipleOfBase, FixedAmount.

value
value double

For multipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this Addition. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

AdditionsToTotal

Name Path Type Description
name
name string

The name of this Total Addition.

type
type string

How this total addition is calculated and applied to the base amount, multipleOfBase is multiplied by baseAnnualSalary and then added to the total while fixed amount is added directly to the total. Enum: MultipleOfBase, FixedAmount.

value
value double

For multipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this Addition. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

Address

Name Path Type Description
addressType
addressType string

The type of address.

fullAddress
fullAddress string

The full address.

country
country string

The country of the address.

postcode
postcode string

The postal code for the address.

state
state string

The state of the address.

street
street string

The street that the address is on.

suburb
suburb string

The suburb of the address.

Breakdown

Name Path Type Description
name
name string

The name of this Addition.

type
type string

How this addition is recorded, it is not used to compute the total package due unlike other remuneration components. Enum: MultipleOfBase, FixedAmount.

value
value double

For multipleOfBase this is the multiplier (e.g. 9 = 9%) while for fixed amount this is the amount to directly add to the total.

currency
currency string

The currency used for this Addition. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

BusinessEntity

Name Path Type Description
id
id string

The identifier string for the Business Entity.

name
name string

Name given to this Business Entity. This name would normally be shown to users of the system.

legalName
legalName string

Legal name can be different from the name presented to a user. Usually used for administrative tasks.

number
number string

Legally registered Business Entity number, e.g. in Australia this might be the ABN, or in America the RN.

isEnabled
isEnabled boolean

Specifies whether users can select this Business Entity in dropdowns.

BusinessUnit3

Name Path Type Description
id
id string

The identifier string for the Business Unit.

identifier
identifier string

Optional identifier that can be used for administrative tasks.

name
name string

Name given to this Business Unit. This name would normally be shown to users of the system.

notes
notes string

Notes attached to a Business Unit

parentId
parentId string

The identifier string for the parent Business Unit, or null if there is no parent (this is a top level business unit).

isEnabled
isEnabled boolean

Specifies whether users can select this Business Unit in dropdowns.

BusinessEntity2

The Job's current Business Entity in the system.

Name Path Type Description
id
id string

The identifier string for the Business Entity of this Job.

name
name string

Name given to this Business Entity. This name would normally be shown to users of the system.

link
link string

Link on the public api to get more information on this piece of data.

BusinessUnit4

The Job's current Business Unit in the system.

Name Path Type Description
id
id string

The identifier string for the Business Unit of this Job.

name
name string

Name given to this Business Unit. This name would normally be shown to users of the system.

link
link string

Link on the public api to get more information on this piece of data.

Coordinator

The Coordinator who did the Training. This data is optional and will be null when not stored.

Name Path Type Description
id
id string

The identifier string for the Coordinator of the Training.

displayName
displayName string

The name of the Person who coordinated the Training.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId double

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

link
link string

Link on the public api to get more information on this piece of data.

CustomFieldDefinition

Name Path Type Description
id
id string

The identifier string for the Custom Field Definition.

name
name string

Name given to this Custom Field Definition. This name would normally be shown to users of the system.

apiName
apiName string

The api name given to this Custom Field Definition. This name is used to uniquely identify the custom field in the api and is used as the key when modifying the custom field on a record.

description
description string

The description of this Custom Field Definition. This is used as a tooltip on the create and update pages.

modelType
modelType string

The model that this custom field relates to and can be attached to. Enum: TRAINING, PERSON.

type
type string

The type of data this field records. Enum: SINGLE_SELECT, MULTI_SELECT, TEXT, NUMBER, PEOPLE_DROPDOWN.

definitions
definitions object

This key's values change depending on the "type" key. It is used to store additional information pertinent to that key. For more information on custom field configurations, see our knowledge base article on custom fields

data1

Name Path Type Description
id
id string

The identifier string for the Person.

displayName
displayName string

Name to display throughout the system for this Person. Generally follows the pattern preferredName (firstName) lastName, but can be configured on a tenant-wide basis to be a different format.

firstName
firstName string

The Person's First Name.

middleName
middleName string

The Person's Middle Name.

lastName
lastName string

The Person's Last Name.

preferredName
preferredName string

The Person's Preferred Name. Can generally be configured by employees for themselves.

dateOfBirth
dateOfBirth string

Date of Birth (YYYY-MM-DD).

gender
gender string

Human readable string for the Person's gender, e.g. Male.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId double

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

title
title string

The title to refer to this Person as, for example "Mr". This is null if not provided.

emailAddresses
emailAddresses array of EmailAddress

An array of email addresses that belong to this Person.

EmergencyContact
emergencyContact EmergencyContact

The details for this Person's emergency contact.

employmentStatus
employmentStatus string

The current status of this Persons within the organisation. Enum: Current Staff, Exiting Staff, No Job Records, Past Staff, Returning Staff, Upcoming Staff.

jobs
jobs array of Job4

An array of simple Job entries associated with this Person in reverse chronological order of start date.

WorkRights
workRights WorkRights

Show the working rights of the person

PrimaryEmailAddress1
primaryEmailAddress PrimaryEmailAddress1

Information about this Person's primary email address, or null if they have no email information.

PrimaryPhoneNumber1
primaryPhoneNumber PrimaryPhoneNumber1

Information about this Person's primary phone number, or null if they have no phone numbers.

addresses
addresses array of Address

An array of addresses that belong to this Person.

phoneNumbers
phoneNumbers array of PhoneNumber

An array of phone numbers that belong to this Person.

createdAt
createdAt string

When this record was created. This date will follow the format defined by RFC3339.

updatedAt
updatedAt string

When this record was last updated. This date will follow the format defined by RFC3339.

Data3

Name Path Type Description
id
id string

The identifier string for the Person Document.

personId
personId string

The identifier string for the Person to whom this Document belongs.

presignedUploadUrl
presignedUploadUrl string

The presigned upload URL which enables you to upload a Person Document to S3. This link will expire 20 minutes after creation. Instructions on how to upload an object with a presigned S3 URL can be found here

Data4

Name Path Type Description
id
id string

The identifier string for the Person Document.

personId
personId string

The identifier string for the Person to whom this Document belongs.

uploadStatus
uploadStatus string

The upload status of this Document. Enum: SUCCESS, PENDING, FAILED.

Data5

Name Path Type Description
id
id string

The identifier string for the Webhook Event.

name
name string

The human readable unique event key for this Webhook Event.

event
event string

The slug of the Webhook Event.

examplePayload
examplePayload object

An example of the payload which will be sent to Webhooks that subscribe to this particular Webhook Event.

Data7

Name Path Type Description
id
id string

The identifier string for the Webhook.

url
url string

The Webhook endpoint which the request will be sent to when the subscribed Webhook Event is triggered.

WebhookEvent
webhookEvent WebhookEvent

The Webhook Event that triggered this Webhook.

isEnabled
isEnabled boolean

Specifies whether users can select this Webhook. When disabled, this Webhook will not be sent.

source
source string

A customizable string which can be used to identify what system created this Webhook. Webhooks created through the intelliHR application will have source: 'custom'.

createdAt
createdAt string

When this record was created. This date will follow the format defined by RFC3339.

updatedAt
updatedAt string

When this record was last updated. This date will follow the format defined by RFC3339.

Deduction

Name Path Type Description
name
name string

The name of this Deduction.

type
type string

How this deduction is calculated and applied to the base amount, multipleOfBase is multiplied by baseAnnualSalary and then deducted from the total while fixed amount is deducted directly from the total. Enum: MultipleOfBase, FixedAmount.

value
value double

For multipleOfBase this is the multiplier while for fixed amount this is the amount to directly deduct from the total.

currency
currency string

The currency used for this Deduction. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

DefaultRemunerationComponent

Name Path Type Description
id
id string

The identifier string for the Default Remuneration Component.

name
name string

Name given to this Default Remuneration Component. This name would normally be shown to users of the system.

value
value string

The value of this remuneration component. For multipleOfBase this is the multiplier while for fixed amount this is the amount to directly add to the total.

isInUse
isInUse boolean

Whether this Default Remuneration Component is used as any remuneration components.

automaticallyAddToJobs
automaticallyAddToJobs boolean

Whether this Default Remuneration Component is automatically added to newly created/updated jobs.

isEnabled
isEnabled boolean

If this Default Remuneration Component is enabled for use in the system.

currency
currency string

The currency used for this Default Remuneration Component. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

type
type string

The type of this Default Remuneration Component. Enum: AdditionToBase, AdditionToTotal, DeductionToBase, Breakdown.

valueType
valueType string

The type of the value of this Default Remuneration Component. Enum: MultipleOfBase, FixedAmount.

EmailAddress

Name Path Type Description
email
email string

The actual email address.

isPrimary
isPrimary boolean

If this is a primary email address.

isPersonal
isPersonal boolean

If this is a personal email address.

EmergencyContact

The details for this Person's emergency contact.

Name Path Type Description
name
name string

The name of the emergency contact.

relationship
relationship string

The relationship this emergency contact has with the Person.

phone
phone string

Phone number of the emergency contact.

email
email string

Email of the emergency contact.

EmploymentCondition

Name Path Type Description
id
id string

The identifier string for the Employment Condition.

name
name string

Name given to this Employment Condition. This name would normally be shown to users of the system.

awardName
awardName string

Award name can be different from the name presented to a user. Usually used for the legal name of the award.

isEnabled
isEnabled boolean

Specifies whether users can select this Employment Condition in dropdowns.

EmploymentCondition2

The Employment Condition this job is being paid under.

Name Path Type Description
id
id string

The identifier string for the Employment Condition of this Remuneration Schedule.

name
name string

Name given to this Employment Condition. This name would normally be shown to users of the system.

awardName
awardName string

Award name can be different from the name presented to a user. Usually used for the legal name of the award.

link
link string

Link on the public api to get more information on this piece of data.

Job

Name Path Type Description
id
id string

The identifier string for the Job.

Person
person Person

The Person to whom this Job belongs.

Recruitment
recruitment Recruitment

The recruitment details stored for this Job.

Location
location Location

The geographical location of this Job.

PayGrade
payGrade PayGrade

The Job's current Pay Grade in the system.

BusinessUnit4
businessUnit BusinessUnit4

The Job's current Business Unit in the system.

BusinessEntity2
businessEntity BusinessEntity2

The Job's current Business Entity in the system.

SupervisorJob
supervisorJob SupervisorJob

The Job information for the supervisor of this Job or null if they have no supervisor.

SupervisorPerson
supervisorPerson SupervisorPerson

The Person information for the supervisor of this job or null if they have no supervisor.

RemunerationSchedule
remunerationSchedule RemunerationSchedule

The current remuneration details for this Job, including information such as salary and hourly pay, all Jobs have a remuneration schedule but for unpaid employees they will have a special No Remuneration Schedule schedule.

name
name string

The name/position title of this Job.

fte
fte number

The full time equivalent of this Job. Indicating the workload of an employee that can be comparable across different contexts. This is null for people without an FTE.

workClass
workClass string

The Work Class of this Job. This is extra details about the Work Type.

workType
workType string

This is the Work Classification for this Job, it is used to differentiate between full-time and part time employees vs unpaid volunteers. Enum: Permanent, Fixed Contract, Unpaid, Temporary/Casual, Independent Contract.

jobStatus
jobStatus string

The current status of this job within this organisation. Enum: Past Job, Future Job, Ending Job, Current Job.

companyStartDate
companyStartDate string

The date this Job started or will start within the organisation. This date will follow the format defined by RFC3339.

companyEndDate
companyEndDate string

The date this Job ended or will end within the organisation or null if there is no end date. This date will follow the format defined by RFC3339.

isEndDateConfirmed
isEndDateConfirmed boolean

Whether the end date has been finalised within the intelliHR application.

turnoverType
turnoverType string

The type of turnover this end of job is classified as.

turnoverReason
turnoverReason string

The name of the turnover reason.

createdAt
createdAt string

When this record was created. This date will follow the format defined by RFC3339.

Job4

Name Path Type Description
id
id string

The identifier string for the Job.

name
name string

The name/position title of this Job.

startDate
startDate string

The date this Job started or will start within the organisation. This date will follow the format defined by RFC3339.

endDate
endDate string

The date this Job ended or will end within the organisation or null if there is no end date. This date will follow the format defined by RFC3339.

jobStatus
jobStatus string

The current status of this Job within this organisation. Enum: Past Job, Future Job, Ending Job, Current Job.

link
link string

Link on the public api to get more information on this piece of data.

Job7

The Job of the Person who did the Training.

Name Path Type Description
id
id string

The identifier string for the Job of the Training.

name
name string

The name of the Persons Job who did the Training.

startDate
startDate string

The Jobs effective start date. This date will follow the format defined by RFC3339.

endDate
endDate string

The Jobs effective end date. This date will follow the format defined by RFC3339.

jobStatus
jobStatus string

The Status Schema. Enum: Past Job, Future Job, Ending Job, Current Job.

link
link string

Link on the public api to get more information on this piece of data.

Links to other related resources.

Name Path Type Description
self
self string

The current page URL

first
first string

The first page URL

prev
prev string

The previous page URL

next
next string

The next page URL

last
last string

The last page URL

Location

The geographical location of this Job.

Name Path Type Description
id
id string

The identifier string for the Location of this Job.

name
name string

Name given to this Location. This name would normally be shown to users of the system.

address
address string

The address of this location.

link
link string

Link on the public api to get more information on this piece of data.

location5

Name Path Type Description
id
id string

The identifier string for the Location.

parentId
parentId string

The identifier string for the parent Location, or null if there is no parent (this is a top level location).

name
name string

Name given to this Location. This name would normally be shown to users of the system.

address
address string

The address of this location.

isEnabled
isEnabled boolean

Specifies whether users can select this Location in dropdowns.

Meta

Contains miscellaneous meta information about the response.

Name Path Type Description
Pagination
pagination Pagination

Contains information related to the pagination of the response

Meta1

Contains miscellaneous meta information about the response.

Name Path Type Description
asAt
asAt string

The point in time for which this response is for. This date will follow the format defined by RFC3339.

Meta2

Contains miscellaneous meta information about the response.

Name Path Type Description
asAt
asAt string

The point in time for which this response is for. This date will follow the format defined by RFC3339.

Pagination
pagination Pagination

Contains information related to the pagination of the response

Meta8

Contains miscellaneous meta information about the response.

Name Path Type Description
asAt
asAt string

The point in time at which the data in this response is accurate. This date will follow the format defined by RFC3339.

Pagination
pagination Pagination

Contains information related to the pagination of the response

Pagination

Contains information related to the pagination of the response

Name Path Type Description
total
total integer

Total items count

count
count integer

Number of items for current page

per_page
per_page integer

Items per page limit

current_page
current_page integer

Current page

total_pages
total_pages integer

Total number of pages

PayGrade

The Job's current Pay Grade in the system.

Name Path Type Description
id
id string

The identifier string for the Pay Grade of this Job.

name
name string

User friendly name given to the Pay Grade.

code
code string

Administrative, short code associated to the Pay Grade.

link
link string

Link on the public api to get more information on this piece of data.

payGrade5

Name Path Type Description
id
id string

The identifier string for the Pay Grade.

code
code string

Administrative, short code associated to the Pay Grade.

name
name string

User friendly name given to the Pay Grade.

isEnabled
isEnabled boolean

Specifies whether users can select this Pay Grade in dropdowns.

Person

The Person to whom this Job belongs.

Name Path Type Description
id
id string

The identifier string for the Person to whom this Job belongs.

displayName
displayName string

Name to display throughout the system for this Person. Generally follows the pattern preferredName (firstName) lastName, but can be configured on a tenant-wide basis to be a different format.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId double

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

link
link string

Link on the public api to get more information on this piece of data.

Person7

The Person who did the Training.

Name Path Type Description
id
id string

The identifier string for the Person of the Training.

displayName
displayName string

The name of the Person who did the Training.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId double

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

link
link string

Link on the public api to get more information on this piece of data.

PhoneNumber

Name Path Type Description
number
number string

The actual phone number.

fullNumber
fullNumber string

The actual phone number with the area code (if registered).

isPrimary
isPrimary boolean

If this is a primary phone number.

isPersonal
isPersonal boolean

If this is a personal phone number.

PrimaryEmailAddress1

Information about this Person's primary email address, or null if they have no email information.

Name Path Type Description
email
email string

The actual email address.

isPersonal
isPersonal boolean

Denotes whether this email is personal or a work email.

PrimaryPhoneNumber1

Information about this Person's primary phone number, or null if they have no phone numbers.

Name Path Type Description
number
number string

The actual phone number.

fullNumber
fullNumber string

The actual phone number with the area code (if registered).

isPersonal
isPersonal boolean

Denotes whether this phone number is a personal or work number.

Provider

The Training Provider of the Training.

Name Path Type Description
id
id string

The identifier string for the Training Provider of the Training.

name
name string

User friendly name given to the Training Provider of the Training.

link
link string

Link on the public api to get more information on this piece of data.

Recruitment

The recruitment details stored for this Job.

Name Path Type Description
cost
cost number

The cost to recruit this Job. If it is null the cost has not been recorded.

currency
currency string

The currency used to recruit this Job. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

Source
source Source

The Recruitment Source this job was sourced from or null if it was not recorded.

recruitmentSource

Name Path Type Description
id
id string

The identifier string for the Recruitment Source.

name
name string

The name given to this recruitment source.

parentId
parentId string

The identifier string for the parent Recruitment Source, or null if there is no parent (this is a top level recruitment source).

isEnabled
isEnabled boolean

Specifies whether users can select this Recruitment Source in dropdowns.

RemunerationSchedule

The current remuneration details for this Job, including information such as salary and hourly pay, all Jobs have a remuneration schedule but for unpaid employees they will have a special No Remuneration Schedule schedule.

Name Path Type Description
type
type string

The method in which this remuneration schedule is paid, if a person is unpaid then this will be No Remuneration Schedule. Enum: Annual Salary, Hourly Rate, No Remuneration Schedule.

baseAnnualSalary
baseAnnualSalary double

The Base Salary paid yearly, this is an approximation if they are paid hourly. Note that if both baseAnnualSalary and baseHourlyRate are provided in a create or patch request, the baseHourlyRate will be ignored.

baseHourlyRate
baseHourlyRate double

The Base Rate paid hourly, this is an approximation if they are paid annually. Note that if both baseAnnualSalary and baseHourlyRate are provided in a create or patch request, the baseHourlyRate will be ignored.

currency
currency string

The currency that the base and total amounts that this job is being paid in. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

hoursPerCycle
hoursPerCycle double

How many hours worked per payCycle.

payCycle
payCycle string

The cycle that the job is paid on. Enum: Weekly, Fortnightly, Monthly.

annualPackage
annualPackage double

The total package paid yearly including additions and deductions. This amount is calculated by adding the Base Annual Salary and additions minus the deductions.

hourlyPackage
hourlyPackage double

The total package paid hourly including additions and deductions. This amount is calculated by dividing the Annual Package by the total number of hours per annum.

currencyConversionOccurred
currencyConversionOccurred boolean

If any conversion had to be performed between addition and deduction currencies when calculating the annual package.

EmploymentCondition2
employmentCondition EmploymentCondition2

The Employment Condition this job is being paid under.

additions
additions array of Addition

An array of Additions for this Remuneration Schedule.

deductions
deductions array of Deduction

An array of Deductions for this Remuneration Schedule.

additionsToTotal
additionsToTotal array of AdditionsToTotal

An array of Additions applied to the package after all other components for this Remuneration Schedule.

breakdowns
breakdowns array of Breakdown

An array of Breakdowns for this Remuneration Schedule. Breakdowns will not be used to calculate the total package.

Source

The Recruitment Source this job was sourced from or null if it was not recorded.

Name Path Type Description
id
id string

The identifier string for the Recruitment Source of this Job.

name
name string

The name given to this Recruitment Source.

link
link string

Link on the public api to get more information on this piece of data.

SupervisorJob

The Job information for the supervisor of this Job or null if they have no supervisor.

Name Path Type Description
id
id string

The identifier string for the Supervisor's Job of this Job.

jobStatus
jobStatus string

The current status of this job within this organisation. Enum: Past Job, Future Job, Ending Job, Current Job.

name
name string

The name/position title of the Supervisor's Job.

link
link string

Link on the public api to get more information on this piece of data.

SupervisorPerson

The Person information for the supervisor of this job or null if they have no supervisor.

Name Path Type Description
id
id string

The identifier string for the Supervisor's Person of this Job.

displayName
displayName string

Name to display throughout the system for this Person. Generally follows the pattern preferredName (firstName) lastName, but can be configured on a tenant-wide basis to be a different format.

employeeNumber
employeeNumber string

A manually entered employee number that identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

autoIncrementIntellihrId
autoIncrementIntellihrId double

An autogenerated number that uniquely identifies a Person in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.

link
link string

Link on the public api to get more information on this piece of data.

Training

Name Path Type Description
id
id string

The identifier string for the Training.

name
name string

User friendly name given to this Training.

Person7
person Person7

The Person who did the Training.

Job7
job Job7

The Job of the Person who did the Training.

Coordinator
coordinator Coordinator

The Coordinator who did the Training. This data is optional and will be null when not stored.

hours
hours string

How many hours were spent on this Training.

currency
currency string

The currency used for this [Training](#tag/Trainings. An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See Official list of codes.

cost
cost string

The cost of this Training.

Provider
provider Provider

The Training Provider of the Training.

Type
type Type

The Training Type of the Training.

completionDate
completionDate string

The timestamp the Training was completed. This date will follow the format defined by RFC3339.

createdAt
createdAt string

When this record was created. This date will follow the format defined by RFC3339.

updatedAt
updatedAt string

When this record was last updated. This date will follow the format defined by RFC3339.

trainingProviders

Name Path Type Description
id
id string

The identifier string for the Training Provider.

name
name string

User friendly name given to the Training Provider.

isDefault
isDefault boolean

Indicates if this Training Provider will be used as a default when creating a Training record.

trainingTypes

Name Path Type Description
id
id string

The identifier string for the Training Type.

name
name string

User friendly name given to the Training Type.

isDefault
isDefault boolean

Indicates if this Training Type will be used as a default when creating a Training record.

Type

The Training Type of the Training.

Name Path Type Description
id
id string

The identifier string for the Training Type of the Training.

name
name string

User friendly name given to the Training Type of the Training.

link
link string

Link on the public api to get more information on this piece of data.

WebhookEvent

The Webhook Event that triggered this Webhook.

Name Path Type Description
id
id string

The identifier string for the Webhook Event.

name
name string

The human readable unique event key for this Webhook Event.

event
event string

The slug of the Webhook Event.

link
link string

Link on the public api to get more information on this piece of data.

WorkClassesSchema

Name Path Type Description
id
id string

The identifier string for the Work Class.

name
name string

Name given to this Work Class. This name would normally be shown to users of the system.

WorkType2
workType WorkType2

The parent Work Type of this Work Class.

isEnabled
isEnabled boolean

Specifies whether users can select this Work Type in dropdowns.

WorkRight2

Name Path Type Description
id
id string

The identifier string for the Work Right.

name
name string

Name given to this Work Right. This name would normally be shown to users of the system.

countryId
countryId string

The identifier string for the Country.

country
country string

The name value of the assigned Country.

WorkRights

Show the working rights of the person

Name Path Type Description
name
name string

The type of the working rights

country
country string

The country where the working rights are valid

expirationDate
expirationDate string

The date the working rights are expiring

WorkType2

The parent Work Type of this Work Class.

Name Path Type Description
id
id string

The identifier string for the Work Type of this Work Class.

name
name string

The name of the Work Type. Enum: Permanent, Fixed Contract, Unpaid, Temporary/Casual, Independent Contract.

link
link string

Link on the public api to get more information on this piece of data.

workType4

Name Path Type Description
id
id string

The identifier string for the Work Type.

name
name string

The name of the Work Type. Enum: Permanent, Fixed Contract, Unpaid, Temporary/Casual, Independent Contract.

isEnabled
isEnabled boolean

Specifies whether users can select this Work Type in dropdowns.

string

This is the basic data type 'string'.