---
title: "GET /v1/scim/groups"
method: GET
path: "/v1/scim/groups"
tags: ["SSOReadyService"]
---

# GET /v1/scim/groups

`GET /v1/scim/groups`

Gets a list of SCIM groups in a SCIM directory.

## Query parameters

- `scimDirectoryId` string
- `organizationId` string
- `organizationExternalId` string
- `pageToken` string

## Response `200`

OK

- ListSCIMGroupsResponse
  - `scimGroups` SCIMGroup[] — List of SCIM groups.
    - `id` string — Unique identifier for this SCIM group.
    - `scimDirectoryId` string — SCIM directory this SCIM group belongs to.
    - `displayName` string — A human-friendly name for the SCIM group.
    - `deleted` boolean — Whether the SCIM group has been deleted or deprovisioned from its SCIM directory. Identity Providers are inconsistent about reliably deleting SCIM groups. Many Identity Providers will deprovision the users inside a group, but not the group itself. For this reason, it's typical to ignore this field until a specific need arises.
    - `attributes` object — Arbitrary, potentially nested, attributes the Identity Provider included about the group. Identity Providers are inconsistent about supporting sending custom attributes on groups. For this reason, it's typical to not rely on them until a specific need arises.
  - `nextPageToken` string — Value to use as `pageToken` for the next page of data. Empty if there is no more data.

## Other responses

- `default` — Default error response

## Changes

- **2024-08-13** `516b78b641b8` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ssoready/apis/ssoreadyservice-api/changes/v1/scim/groups/get.md)

---

[API](https://skmtc.dev/ssoready/apis/ssoreadyservice-api.md) · [All operations](https://skmtc.dev/ssoready/apis/ssoreadyservice-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ssoready/ssoreadyservice-api/revisions/0827d713f08e/schema)