Adoptions

Gets a single Adoption referenced by ID.

Changed on Nov 10, 2026

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

Path parameters

idstring required

Adoption ID.

Response

FormReceivedDatestring date-time nullable

The date that certificate (form MAT B1) was received by the employer.

Cascade Source: [EmployeeMaternity].[MAT1BReceived]

ExpectedDateOfBirthstring date-time nullable

The expected date of birth of the child.

Cascade Source: [EmployeeMaternity].[ExpectedDate]

ExpectedWeekOfChildBirthStartDatestring date-time nullable

The date of the Sunday before the date of birth of the child.

ExpectedWeekOfChildBirthEndDatestring date-time nullable

The date of the Saturday after the date of birth of the child.

ChildDateOfBirthstring date-time nullable

The actual date of birth of the child.

Cascade Source: [EmployeeMaternity].[BabyDOB]

ChildNamestring nullable

The name of the child.

Cascade Source: [EmployeeMaternity].[BabyName]

NotificationReceivedDatestring date-time nullable

The date that the Employer was notified.

Cascade Source: [EmployeeMaternity].[NotificationReceived]

NotifyEmployerByDatestring date-time nullable

Cascade Source: [EmployeeMaternity].[NoticeDate]

LeaveStartDatestring date-time nullable

The start date of the Employee's leave.

Cascade Source: [EmployeeMaternity].[StartDate]

LeaveEndDatestring date-time nullable

The end date of the Employee's leave. Cascade Source: [EmployeeMaternity].[EndDate]

Narrativestring nullable

Cascade Source: [EmployeeMaternity].[Notes]

EmployeeIdstring nullable

The Id of the Employee.

Must exist in the Employee service.

AbsenceIdstring nullable

The Id of the Attendance Absence record.

Must exist in the Absence service.

IntentionToReturnSentDatestring date-time nullable

The date the Employer is notified of the Employee's intention to return to work.

Cascade Source: [EmployeeMaternity].[IntentionToReturnSent]

ReturnToWorkIntentionstring nullable

The Employees intention to return to work after maternity leave.

Cascade Source: [EmployeeMaternity].[IntentionToReturnType] translated through RETURNTOWORK system list.

ExpectedReturnDatestring date-time nullable

The date the Employee is expected to return to work.

Cascade Source: [EmployeeMaternity].[IntendedReturnDate]

QualifyingWeekStartDatestring date-time nullable

The 15th Week before the Expected Week of child birth start date.

QualifyForExtendLeaveboolean nullable

Employee qualifies for externded leave.

Cascade Source: [EmployeeMaternity].[ExtendLeave]

IsSurrogacyCaseboolean

Is this a Surrogacy case?

Cascade Source: [EmployeeMaternity].[IsSurrogacyCase]

PlacementDatestring date-time nullable

Cascade Source: [EmployeeMaternity].[PlacementDate]

SourceSystemIdstring nullable

Source HR System Id.

Cascade Source: [EmployeeMaternity].[RUID]

SourceSystemCreatedOnstring date-time nullable

The date when the Adoption was created in the Source HR System.

Cascade Source: [EmployeeMaternity].[SYS_EffectiveDate]

SourceSystemLastModifiedOnstring date-time nullable

The date when the Adoption was created or last updated in the Source HR System.

Cascade Source: [EmployeeMaternity].[SYS_ModifiedDate]

Idstring nullable

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

CreatedOnstring date-time

The date when the Adoption 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 Adoption was created or last updated.

LastModifiedBystring nullable

Not used as the 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
- warning
  for the path request parameter id, the maxLength was set to 36
- 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
Oct 6, 20267a4734dbe370 Revision changes
- info
  endpoint added

Operation history

Gets a single Adoption referenced by ID.

Request

Path parameters

Response 200OK

Changes

Response