---
title: "Gets a list of Adoptions."
method: GET
path: "/attendance/adoptions"
tags: ["Adoptions"]
---

# Gets a list of Adoptions.

`GET /attendance/adoptions`

## Request

- Base URL: `https://api.iris.co.uk/hr/v2`
- URL: `https://api.iris.co.uk/hr/v2/attendance/adoptions`
- 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/adoptions/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `$top` integer
- `$skip` integer
- `$filter` string
- `$select` string[]
- `$orderby` string
- `$count` boolean

## Response `200`

OK

- AdoptionQueryModel
  - `@odata.context` string, nullable
  - `@odata.count` integer, nullable
  - `@odata.nextlink` string, nullable
  - `value` array[], nullable
    - AdoptionModel[]
      - `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]
      - `IsSurrogacyCase` boolean: Is this a Surrogacy case? Cascade Source: [EmployeeMaternity].[IsSurrogacyCase]
      - `PlacementDate` string, date-time, nullable: Cascade Source: [EmployeeMaternity].[PlacementDate]
      - `SourceSystemId` string, nullable: Source HR System Id. Cascade Source: [EmployeeMaternity].[RUID]
      - `SourceSystemCreatedOn` string, date-time, nullable: The date when the Adoption was created in the Source HR System. Cascade Source: [EmployeeMaternity].[SYS_EffectiveDate]
      - `SourceSystemLastModifiedOn` string, date-time, nullable: The date when the Adoption 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 Adoption 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 Adoption was created or last updated.
      - `LastModifiedBy` string, nullable: Not used as the Iris HR platform has no concept of users.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

## Changes

- **2026-11-10** `638d402d3872`: 2 warning, 42 info
  - for the `query` request parameter `$filter`, the maxLength was set to `2000`
  - for the `query` request parameter `$skip`, the max was set to `2147483647.00`
  - media type `application/json; version=1` was changed to `application/json` for the response status `200`
  - media type `application/json; version=1` was changed to `application/json` for the response status `400`
  - …40 more
- **2026-10-06** `7a4734dbe370`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hrapi/apis/hr-api/changes/attendance/adoptions/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)