Employees

Gets a single Employee referenced by ID.

Changed on Nov 10, 2026

get/employees/{id}

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/employees/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Employee ID.

Response

DisplayIdstring nullable

The Display ID of the Employee.

If provided must be unqiue, If null then it will automatically be generated.

Cascade Source: [Employee].[DisplayEmployeeId]

TitleHonorificstring nullable

The Title of the Employee. E.g. Mr, Mrs, Miss.

Cascade Source: [Employee].[Title] translated through the TITLE system list.

FirstNamestring nullable required

The First Name of the Employee.

Cascade Source: [Employee].[Forename]

KnownAsstring nullable

The name the Employee is commonly known as.

Cascade Source: [Employee].[KnownAs]

OtherNamestring nullable

Any other name that the Employee has.

Cascade Source: [Employee].[OtherName]

LastNamestring nullable required

The Last Name, Surname or Family Name of the Employee.

Cascade Source: [Employee].[Surname]

CostCentrestring nullable

The Cost Centre assigned to the Employee.

Cascade Source: [Employee].[CostCentre]

WorkingStatusstring nullable

The Status of the Employee E.g. On Holiday, Sick.

Automatically Calculated.

Cascade Source: [Sysview_Employee_Status].[StatusDescription]

IsManagerboolean nullable

Indicates if the Employee is a Manager.

True if any other Employee's active <see cref="T:Iris.Api.Hr.Employee.Domain.Entities.V2.Job">Job</see> has this Employee as their Line Manager.

Automaticaly Calculated.

NationalInsuranceNumberstring nullable

The National Insurance Number of the Employee.

Cascade Source: [Employee].[NationalInsuranceNo]

PayrollIdstring nullable

The Payroll ID of the Employee.

Cascade Source: [Employee].[PayrollId]

TaxCodestring nullable

The Tax Code of the Employee.

Cascade Source: [Employee].[TaxCode]

IncludeInPayrollboolean nullable

Indicates if the Employee should be included in Payroll.

Cascade Source: [Employee].[IncludeInPayroll]

EmploymentStartDatestring date-time nullable

The date the Employee started with their current Employer.

Cascade Source: [Employee].[EmployeeStartDate]

EmploymentLeftDatestring date-time nullable

The date the Employee left their current Employer.

Cascade Source: [Employee].[LeftDate]

ContinuousServiceDatestring date-time nullable

The date the Employee's continuous service should be applied from.

Cascade Source: [Employee].[ContServiceDate]

DateOfBirthstring date-time nullable

The Date of Birth of the Employee.

Cascade Source: [Employee].[DateOfBirth]

LastWorkingDatestring date-time nullable

The date of the last working date of the Employee.

Cascade Source: [Employee].[LeaverLastWorkDate]

Genderstring nullable

The Gender of the Employee.

Cascade Source: [Employee].[Sex] translated through the GENDER system list.

Ethnicitystring nullable

The Ethnicity of the Employee.

Cascade Source: [Employee].[EthnicOrigin] translated through the ETHNICTORIGIN system list.

Nationalitystring nullable

The Nationality of the Employee.

Cascade Source: [Employee].[Nationality] translated through the NATIONALITY system list.

Religionstring nullable

The Religion of the Employee.

Cascade Source: [Employee].[Religion] transalated through the RELIGION system list.

LeaverReasonstring nullable

The reason for the Employee to Leave.

Cascade Source: [Employee].[LeaverReason]

MaritalStatusstring nullable

The marrital status of the Employee.

Cascade Source: [Employee].[MaritalStatus] translated through the MARITALSTATUS system list.

GenderIdentitystring nullable

The Gender Identity of the Employee.

Cascade Source: [Employee].[GenderIdentity] translated through the GenderIdentity system list.

WindowsUsernamestring nullable

The Windows Username of the Employee.

Cascade Source: [Employee].[WindowsUsername]

PayrollCompanyNamestring nullable

The Payroll Company Name of the Employee.

Cascade Source: [Employee].[PayrollCompanyName]

Initialsstring nullable

The Initials of the Employee.

Cannot be updated once Employee is created to prevent breaking change to API functionality.

Cascade Source: [Employee].[Initials]

LengthOfServiceYearsinteger nullable

The number of whole years between the employees Cont. Service Date and Left Date or now, which ever comes first.

LengthOfServiceMonthsinteger nullable

The number of whole months between the employees Cont. Service Date and Left Date or now, which ever comes first.

SourceSystemIdstring nullable

The Internal ID for the source HR Product.

Cascade Source: [Employee].[EmployeeId]

SourceSystemCreatedOnstring date-time nullable

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

Cascade Source: [Employee].[SYS_EffectiveDate]

SourceSystemLastModifiedOnstring date-time nullable

The latest date when the Employee record was created or last updated in the Source HR System.

Cascade Source: [Employee].[SYS_ModifiedDate]

Idstring nullable

This ID is generated by the Iris HR platform and does not relate to the Cascade Employee ID.

CreatedOnstring date-time

The date when the Employee was created in the Iris HR platform.

CreatedBystring nullable

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

LastModifiedOnstring date-time nullable

The date when the Employee was created or last updated.

LastModifiedBystring nullable

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

Changes

Nov 10, 2026638d402d3872 Revision changes
- breaking
  added the pattern ^[0-9a-fA-F-]{36}$ to the path request parameter id
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=minimal)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=full;odata.streaming=true)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=full;odata.streaming=false)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=full)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=none;odata.streaming=true)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=none;odata.streaming=false)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=none)
- breaking
  the response property became nullable for the status (media type: application/json;odata.streaming=true)
- breaking
  the response property became nullable for the status (media type: application/json;odata.streaming=false)
- breaking
  the response property became nullable for the status (media type: application/json)
- breaking
  the response property became nullable for the status (media type: application/xml)
- breaking
  the response property became nullable for the status (media type: text/plain)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=minimal)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=full;odata.streaming=true)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=full;odata.streaming=false)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=full)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=none;odata.streaming=true)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=none;odata.streaming=false)
- breaking
  the response property became nullable for the status (media type: application/json;odata.metadata=none)
- breaking
  the response property became nullable for the status (media type: application/json;odata.streaming=true)
- breaking
  the response property became nullable for the status (media type: application/json;odata.streaming=false)
- breaking
  the response property became nullable for the status (media type: application/json)
- breaking
  the response property became nullable for the status (media type: application/xml)
- breaking
  the response property became nullable for the status (media type: text/plain)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=minimal)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=full;odata.streaming=true)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=full;odata.streaming=false)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=full)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=none;odata.streaming=true)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=none;odata.streaming=false)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=none)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.streaming=true)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.streaming=false)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/xml)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: text/plain)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=minimal)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=full;odata.streaming=true)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=full;odata.streaming=false)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=full)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=none;odata.streaming=true)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=none;odata.streaming=false)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.metadata=none)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.streaming=true)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json;odata.streaming=false)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/json)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: application/xml)
- breaking
  the response property's minLength was decreased from 1 to 0 for the response status (media type: text/plain)
- warning
  for the path request parameter id, the maxLength was set to 36
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=minimal;odata.streaming=true)
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=minimal;odata.streaming=false)
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=minimal)
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=full;odata.streaming=true)
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=full;odata.streaming=false)
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=full)
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=none;odata.streaming=true)
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=none;odata.streaming=false)
- info
  added the optional property to the response with the status (media type: application/json;odata.metadata=none)
- info
  added the optional property to the response with the status (media type: application/json;odata.streaming=true)
- info
  added the optional property to the response with the status (media type: application/json;odata.streaming=false)
- info
  added the optional property to the response with the status (media type: application/json)
- info
  added the optional property to the response with the status (media type: application/xml)
- info
  added the optional property to the response with the status (media type: text/plain)
Oct 6, 20267a4734dbe370 Revision changes
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json; version=2 was changed to application/json for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full; version=2 was changed to application/json;odata.metadata=full for the response status
- info
  media type application/json;odata.metadata=full;odata.streaming=false; version=2 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=2 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=2 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=2 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=2 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=2 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal; version=2 was changed to application/json;odata.metadata=minimal for the response status
- info
  media type application/json;odata.metadata=minimal;odata.streaming=false; version=2 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=2 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=2 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=2 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=2 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=2 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none; version=2 was changed to application/json;odata.metadata=none for the response status
- info
  media type application/json;odata.metadata=none;odata.streaming=false; version=2 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=2 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=2 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=2 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=2 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=2 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=false; version=2 was changed to application/json;odata.streaming=false for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/json;odata.streaming=true; version=2 was changed to application/json;odata.streaming=true for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type application/xml; version=2 was changed to application/xml for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status
- info
  media type text/plain; version=2 was changed to text/plain for the response status

Operation history (4 revisions)

Gets a single Employee referenced by ID.

Request

Path parameters

Response 200OK

Changes

Response