AbsenceDays5

AbsenceReasons6

Absences7

Adoptions2

BankDetails5

Benefits6

Calendar1

EmergencyContacts5

Employees13

Entitlements2

Hierarchy4

Jobs5

Maternities2

Paternities2

Positions4

PublicHolidays3

UserDefinedFields3

UserDefinedFieldSchemas2

WorkingPatternComponents3

WorkingPatternOverride1

WorkingPatternOverrideComponents5

WorkingPatterns2

Hierarchy

Gets a Hierarchy Path by ID. The path is an array of nodes traversed from the root to the node specified.

Changed on Nov 10, 2026

get/hierarchy/{id}/path

Request

Base URL
https://api.iris.co.uk/hr/v2
Auth
OAuth 2
Client credentials
Token URLhttps://api.iris.co.uk/oauth2/v1/token
TypeScript
https://skmtc.dev/hrapi/apis/hr-api/docs/hierarchy/:id/path/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Hierarchy Node ID.

Response

ParentIdstring nullable

The Parent ID of this Hierarchy node.

Must exist in the Hierarchy Service.

Levelinteger

The Level of the Hierarchy node.

Cascade Source: [ValidHierarchyX].[level]

Titlestring nullable

The Title of this Hierarchy node.

Cascade Source: [ValidHierarchyX].[name]

Disabledboolean

Hierarchy node is disabled.

Cascade Source: [ValidHierarchyX].[disabled]

SourceSystemIdstring nullable

Source HR System Id.

Cascade Source: [ValidHierarchyX].[HierarchyNode]

SourceSystemCreatedOnstring date-time nullable

The date when the Hierarchy node record was created in the Source HR System.

Cascade Source: [ValidHierarchyX].[createdon]

SourceSystemLastModifiedOnstring date-time nullable

The date when the Hierarchy node record was created or last updated in the Source HR System.

Cascade Source: [ValidHierarchyX].[disabledon] if exists else [ValidHierachyX].[createdon]

Idstring nullable

This ID of the Hierarchy node.

This field is generated by Iris HR platform and not related to the Cascade ID.

CreatedOnstring date-time

The date time when the Hierarchy node was created in the Iris HR platform.

CreatedBystring nullable

Not used as the Iris HR platform has no concept of users at the moment.

LastModifiedOnstring date-time nullable

The date time when the Hierarchy node was created or last updated.

LastModifiedBystring nullable

Not used as the Iris HR platform has no concept of users at the moment.

Changes

Nov 10, 2026638d402d3872 Revision changes
- breaking
  added the pattern ^[0-9a-fA-F-]{36}$ to the path request parameter id
- warning
  for the path request parameter id, the maxLength was set to 36
Oct 6, 20267a4734dbe370 Revision changes
- info
  media type application/json; version=1 was changed to application/json for the response status
- info
  media type application/json; version=1 was changed to application/json for the response status
- info
  media type application/json; version=1 was changed to application/json for the response status
- info
  media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/xml; version=1 was changed to application/xml for the response status
- info
  media type application/xml; version=1 was changed to application/xml for the response status
- info
  media type application/xml; version=1 was changed to application/xml for the response status
- info
  media type text/plain; version=1 was changed to text/plain for the response status
- info
  media type text/plain; version=1 was changed to text/plain for the response status
- info
  media type text/plain; version=1 was changed to text/plain for the response status

Operation history (3 revisions)

Gets a Hierarchy Path by ID. The path is an array of nodes traversed from the root to the node specified.

Request

Path parameters

Response 200OK

Changes

Response