---
title: "Get Groups"
method: GET
path: "/api/hris/v1/groups"
tags: ["Group"]
---

# Get Groups

`GET /api/hris/v1/groups`

Returns a list of Group objects.

## Query parameters

- `ids` string, nullable — The ID of the groups to fetch
- `remote_id` string — The third-party API ID of the matching object.
- `parent_group_id` string, nullable — The ID of the parent group to filter by
- `type` string, nullable — The type of the group to filter by
- `include_raw_data` boolean — Whether to include the original data Bindbee fetched from the third-party to produce these models.
- `include_custom_fields` boolean — Whether to include custom fields in the response.
- `page_size` integer — Number of results to return per page. Maximum size is 200.
- `cursor` string — The pagination cursor value.
- `modified_after` string — If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

## Headers

- `x-connector-token` string, required

## Response `200`

Successful Response

- PaginatedResponseHrisGroup
  - `cursor` string, nullable, required — Cursor value to fetch next set of items
  - `page_size` integer, required — Indicates the count of items in the response
  - `items` HrisGroup[], required — List of items in the current response
    - `id` string, uuid, required
    - `remote_id` string, nullable, required — The third-party API ID of the matching object.
    - `modified_at` string, required — This is the datetime that this object was last updated by Bindbee
    - `raw_data` object, nullable — This is the Raw data
    - `custom_fields` object, nullable, required — The custom fields related to the model
    - `name` string, nullable, required — The group name.
    - `type` 'COST_CENTER' | 'DEPARTMENT' | 'BUSINESS_UNIT' | 'DIVISION' | 'TEAM', nullable, required — The group type.
    - `parent_group` string, uuid, nullable, required — The parent group id.
    - `is_commonly_used_as_team` boolean, nullable, required — The group is commonly used as a team.

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

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