---
title: "Gets a single Maternity referenced by ID."
method: GET
path: "/attendance/maternities/{id}"
tags: ["Maternities"]
---

# Gets a single Maternity referenced by ID.

`GET /attendance/maternities/{id}`

## Request

- Base URL: `https://api.iris.co.uk/hr/v2`
- URL: `https://api.iris.co.uk/hr/v2/attendance/maternities/{id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.iris.co.uk/oauth2/v1/token`
- TypeScript: <https://skmtc.dev/hrapi/apis/hr-api/docs/attendance/maternities/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required

## Response `200`

OK

- MaternityModel: An HR Employee's Attendance Maternity.
  - `FormReceivedDate` string, date-time, nullable: The date that certificate (form MAT B1) was received by the employer. Cascade Source: [EmployeeMaternity].[MAT1BReceived]
  - `ExpectedDateOfBirth` string, date-time, nullable: The expected date of birth of the child. Cascade Source: [EmployeeMaternity].[ExpectedDate]
  - `ExpectedWeekOfChildBirthStartDate` string, date-time, nullable: The date of the Sunday before the date of birth of the child.
  - `ExpectedWeekOfChildBirthEndDate` string, date-time, nullable: The date of the Saturday after the date of birth of the child.
  - `ChildDateOfBirth` string, date-time, nullable: The actual date of birth of the child. Cascade Source: [EmployeeMaternity].[BabyDOB]
  - `ChildName` string, nullable: The name of the child. Cascade Source: [EmployeeMaternity].[BabyName]
  - `NotificationReceivedDate` string, date-time, nullable: The date that the Employer was notified. Cascade Source: [EmployeeMaternity].[NotificationReceived]
  - `NotifyEmployerByDate` string, date-time, nullable: Cascade Source: [EmployeeMaternity].[NoticeDate]
  - `LeaveStartDate` string, date-time, nullable: The start date of the Employee's leave. Cascade Source: [EmployeeMaternity].[StartDate]
  - `LeaveEndDate` string, date-time, nullable: The end date of the Employee's leave. Cascade Source: [EmployeeMaternity].[EndDate]
  - `Narrative` string, nullable: Cascade Source: [EmployeeMaternity].[Notes]
  - `EmployeeId` string, nullable: The Id of the Employee. Must exist in the Employee service.
  - `AbsenceId` string, nullable: The Id of the Attendance Absence record. Must exist in the Absence service.
  - `IntentionToReturnSentDate` string, date-time, nullable: The date the Employer is notified of the Employee's intention to return to work. Cascade Source: [EmployeeMaternity].[IntentionToReturnSent]
  - `ReturnToWorkIntention` string, nullable: The Employees intention to return to work after maternity leave. Cascade Source: [EmployeeMaternity].[IntentionToReturnType] translated through RETURNTOWORK system list.
  - `ExpectedReturnDate` string, date-time, nullable: The date the Employee is expected to return to work. Cascade Source: [EmployeeMaternity].[IntendedReturnDate]
  - `QualifyingWeekStartDate` string, date-time, nullable: The 15th Week before the Expected Week of child birth start date.
  - `QualifyForExtendLeave` boolean, nullable: Employee qualifies for externded leave. Cascade Source: [EmployeeMaternity].[ExtendLeave]
  - `SourceSystemId` string, nullable: Source HR System Id. Cascade Source: [EmployeeMaternity].[RUID]
  - `SourceSystemCreatedOn` string, date-time, nullable: The date when the Maternity was created in the Source HR System. Cascade Source: [EmployeeMaternity].[SYS_EffectiveDate]
  - `SourceSystemLastModifiedOn` string, date-time, nullable: The date when the Maternity was created or last updated in the Source HR System. Cascade Source: [EmployeeMaternity].[SYS_ModifiedDate]
  - `Id` string, nullable: This ID is generated by the Iris HR platform and does not relate to the Cascade ID.
  - `CreatedOn` string, date-time: The date when the Maternity was created in the Iris HR platform.
  - `CreatedBy` string, nullable: Not used as the Iris HR platform has no concept of users.
  - `LastModifiedOn` string, date-time, nullable: The date when the Maternity was created or last updated.
  - `LastModifiedBy` string, nullable: Not used as the Iris HR platform has no concept of users.

## Other responses

- `401`: Unauthorized
- `404`: Not Found

## Changes

- **2026-11-10** `638d402d3872`: 1 breaking, 1 warning
  - added the pattern `^[0-9a-fA-F-]{36}$` to the `path` request parameter `id`
  - for the `path` request parameter `id`, the maxLength was set to `36`
- **2026-10-06** `7a4734dbe370`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hrapi/apis/hr-api/changes/attendance/maternities/:id/get.md)

---

[API](https://skmtc.dev/hrapi/apis/hr-api.md) - [All operations](https://skmtc.dev/hrapi/apis/hr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hrapi/apis/hr-api/revisions/638d402d3872?raw)