---
title: "List All Groups"
method: GET
path: "/scim/v2/Groups"
tags: ["SCIM"]
---

# List All Groups

`GET /scim/v2/Groups`

## Request

- Base URL: `https://api.byndid.com`
- URL: `https://api.byndid.com/scim/v2/Groups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/docs/scim/v2/Groups/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of SCIM Group resources that match the specified filter criteria.
Send a GET request to `/Groups`.

Note that this method includes the RBAC access groups as well as groups created through the Admin Console.

Filtering ([RFC-7644 §3.4.2.2](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2)):
- Supports 'eq' (equals) and 'ne' (not equals) operators
- Filterable attributes: displayName
- Example: filter=displayName eq "Engineering"

Pagination ([RFC-7644 §3.4.2.4](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.4)):
- Use startIndex (1-based) and count parameters
- Maximum page size: 1000 items
- If count is not specified or is zero, no resources will be returned
- Response includes totalResults for determining additional pages

Sorting:
- No sorting parameters are supported; response order is undefined

## Query parameters

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

## Response `200`

Successfully returns a ListResponse containing the requested Groups. As per [RFC-7644 §3.4.2](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2),  the response includes: - schemas: List of response schema URNs - totalResults: Total number of results matching the query - Resources: Array of Group objects matching query criteria - startIndex: Starting index of results (1-based) - itemsPerPage: Number of results returned

- object: Response for ListGroups.
  - `schemas` string[], required: The list of schemas used to define the list response. This only contains the ListResponse schema ("urn:ietf:params:scim:api:messages:2.0:ListResponse").
  - `Resources` SCIMGroup[], required: An array of groups corresponding to the filter from the request.
    - `schemas` string[], required: The list of schemas used to define the group. This must contain the core Group schema ("urn:ietf:params:scim:schemas:core:2.0:Group") and may include the custom Beyond Identity Group schema extension ("urn:scim:schemas:extension:byndid:1.0:Group").
    - `id` string, required: The unique ID of the group. This is automatically generated on creation. This field is immutable and output-only.
    - `displayName` string, required: The unique display name of the group. This name is used for display purposes.
    - `members` object[]: The list of the group's members.
      - `display` string: The display name of the group member, primarily used for display purposes.
      - `value` string: ID of the user resource corresponding to the group member. This field is immutable.
      - `$ref` string: The URI to another user resource that is a member of the group. This is field is only used for requests and is not returned on the response.
      - `type` string: The resource type of the group member. Currently, only users are supported as group members. This field is only used for requests and is not returned on the response. Specifying a group as a group member on a request is unsupported and will result in undefined behavior.
    - `urn:scim:schemas:extension:byndid:1.0:Group` object, required: The Beyond Identity Group schema extension.
      - `description` string, required: Description of the group.
    - `meta` Meta, required (unresolved $ref)
  - `totalResults` integer, required: Total number of results matching the request. This value may be larger than the number of resources returned, such as when returning a single page of results where multiple pages are available.
  - `startIndex` integer, required: The 1-based index of the first result in the current set of list results.
  - `itemsPerPage` integer, required: The number of resources returned in a list response page.

## Other responses

- `400`: Request validation error. May occur due to: - Invalid filter syntax (see [RFC-7644 §3.4.2.2](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2)) - Unsupported filter operators or attributes - Invalid pagination parameters - Malformed request body - Schema validation failures
- `401`: Authentication failed or was not provided. As per [RFC-7644 §2](https://datatracker.ietf.org/doc/html/rfc7644#section-2), all SCIM requests require authentication using Bearer token.
- `429`: Rate limit exceeded. The server is refusing to process the request due to rate limiting. Clients should respect the RateLimit headers and implement appropriate backoff strategies.
- `500`: Server error.

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/revisions/562e14b2e4ba?raw)