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

# List Groups

`GET /Groups`

## Request

- Base URL: `https://api.oneflow.com/scim/v1`
- URL: `https://api.oneflow.com/scim/v1/Groups`
- Auth: HTTP bearer

Use this endpoint to get the list of groups.

## Query parameters

- `sortBy` string
- `sortOrder` 'ascending' | 'descending'
- `startIndex` integer
- `count` integer
- `attributes` string
- `excludedAttributes` string
- `filter` string

## Response `200`

Returns the list of groups, optionally group attributes are filtered by attributes or excludedAttributes parameters.

- GroupsList: Represents list of groups.
  - `itemsPerPage` integer: The number of resources returned in a list response page.
  - `Resources` Group[], required: A list of the Groups.
    - `displayName` string: A human-readable name for the Group.
    - `externalId` string, nullable: A custom, user-supplied ID.
    - `id` string: The ID of this resource instance.
    - `members` object[]: A list of members of the Group.
      - `type` string: The name of the resource type of the resource. Always 'User'.
      - `value` string: The ID of the user.
      - `x-ref` string: The URI of the corresponding 'User' resource.
      - `display` string, nullable: Compatibility field, accepted but discarded.
    - `meta` object, nullable: An object containing group metadata properties.
      - `created` string, datetime: The time when the group was created.
      - `lastModified` string, datetime: The time when the group was last modified.
      - `location` string: The URI of the group being returned.
      - `resourceType` string: The name of the resource type of the resource. Always 'Group'.
    - `schemas` string[]: A schema for representing the group's configuration.
  - `schemas` string[]: A schema for representing the resource list configuration.
  - `startIndex` integer: The 1-based index of the first result in the current set of list results.
  - `totalResults` integer, required: The total number of results returned by the list or query operation.

## Other responses

- `400`: Invalid format or content of the request.
- `401`: The SCIM token is invalid.

---

[API](https://skmtc.dev/oneflow/apis/scim-api-for-oneflow.md) - [All operations](https://skmtc.dev/oneflow/apis/scim-api-for-oneflow/llms.txt) - [OpenAPI document](https://skmtc.dev/oneflow/apis/scim-api-for-oneflow/revisions/4373300e62fb?raw)