---
title: "List all Groups"
method: GET
path: "/Groups"
tags: ["Groups"]
---

# List all Groups

`GET /Groups`

Documentation on listing Groups via SCIM. 

**OAuth Scope required:** `scim.groups.readGroups`

## Query parameters

- `startIndex` integer
- `count` integer
- `filter` string
- `excludedAttributes` string

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Response `200`

200 OK

- object
  - `schemas` string[]
  - `totalResults` integer — The total number of groups that match this filter. This may be larger than the number of groups in this page, in which case pagination may be used to retrieve the next page of results.
  - `Resources` GroupResponseObject[] — The current page of user results.
    - `schemas` string[], required
    - `displayName` string — The name of the group.
    - `id` string, required — The group's identifier.
    - `externalId` string — An optional identifier of the group sourced from the identity provider.
    - `members` object[] — The list of users who are members of this group.
      - `type` 'User' — The type of member for this group. This is usually 'User'.
      - `value` string — The user's identifier.
    - `meta` object — Metadata for the group.
      - `resourceType` 'Group' — Type of the SCIM resource. In this case: 'Group'.
      - `location` string, https-url — The URI of the Group resource being returned.
  - `startIndex` integer — The 1-based index of the first result in the current set of list results.
  - `itemsPerPage` integer — Specifies the maximum number of resources that can be returned in a single page of results.

## Other responses

- `400` — 400 Bad Request
- `403` — 403 Forbidden
- `500` — 500 Internal Server Error

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)