---
title: "List employees in a group"
method: GET
path: "/groups/{group_id}/employees"
tags: ["Groups"]
---

# List employees in a group

`GET /groups/{group_id}/employees`

Returns a list of `employees` in a `group` with their policies and enrolments. The `employees` are returned sorted by addition date, with the most recently added `employees` appearing first.

## Path parameters

- `group_id` string, required

## Query parameters

- `employee_id` string
- `page` integer — The page of results to return. Defaults to 1 if not provided.
- `page_size` integer — The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

## Headers

- `X-Platform-Id` string

## Response `200`

OK

- GroupEmployeeResponsePagedList
  - `items` GroupEmployeeResponse[], required — A paginated array containing the response elements
    - `object` string — The object type
    - `id` string, required — Unique identifier for the employee.
    - `group_id` string, required — Unique identifier for the group.
    - `policies` PolicyReference[], required — List of policies associated with the employee in this group.
      - `id` string, required — Unique identifier for the policy.
    - `enrolments` EnrolmentReference[], required — List of enrolments associated with the employee in this group.
      - `id` string, required — Unique identifier for the enrolment.
    - `desired_policy_start_date` string, date, nullable — The desired date for the employee's policy to start. This date is not guaranteed to be honored by the insurance provider and may be adjusted based on provider-specific rules and requirements.
    - `enrolment_date` string, date, nullable — The date on which the employee agreed to enrol into the group's policies. This date may be used by some insurance providers to determine the policy start date.
    - `eligibility_status` 'pending' | 'eligible' | 'ineligible', required
    - `enrolment_status` 'enrolled' | 'enrolling' | 'opted_out' | 'cancelled' | 'enrolment_available' | 'not_available', required
    - `scheduled_group_transitions` ScheduledGroupTransitionResponse[], required — List of scheduled group transitions for the employee. Only includes pending transitions.
      - `new_group_id` string, required — Unique identifier for the group the employee will be moved to
      - `scheduled_date` string, date, required — The date when the employee will be moved to the new group
  - `page` integer, required — The current page of the results
  - `page_size` integer, required — The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size
  - `total_count` integer, required — The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.
  - `has_next_page` boolean — Whether there are more pages available after this page
  - `has_previous_page` boolean — Whether there are more pages available before this page

---

[API](https://skmtc.net/kota/apis/kota-api.md) · [All operations](https://skmtc.net/kota/apis/kota-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kota/kota-api/versions/7b8b3ed87c96/schema)
