> ## Documentation Index
> Fetch the complete documentation index at: https://docs.attio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List SCIM groups

> Lists all SCIM groups in the workspace, with optional filtering and pagination.

Required scopes: `user_management:read`.

<h4 style={{borderBottom:"none"}}>Authorizations</h4>

<ParamField header="Authorization" type="string" required>
  This API uses OAuth 2.0 with the authorization code grant flow.
</ParamField>

<h4 style={{borderBottom:"none"}}>Query</h4>

<ParamField query="filter" type="string">
  A SCIM filter expression. Supported attributes: `displayName`. Example: `displayName eq "Engineering"`.
</ParamField>

<ParamField query="startIndex" type="integer" default="1">
  1-based index of the first result to return.
</ParamField>

<ParamField query="count" type="integer">
  Maximum number of results to return. Capped at 100.
</ParamField>

<ParamField query="excludedAttributes" type="string">
  Comma-separated list of attributes to exclude from results. Supports `"members"` to omit the members array for efficiency.
</ParamField>

<h4 style={{borderBottom:"none"}}>Response</h4>

<ResponseField name="schemas" type="string[]">
  Always `["urn:ietf:params:scim:api:messages:2.0:ListResponse"]`.
</ResponseField>

<ResponseField name="totalResults" type="integer">
  Total number of groups matching the filter.
</ResponseField>

<ResponseField name="startIndex" type="integer">
  The 1-based index of the first result returned.
</ResponseField>

<ResponseField name="itemsPerPage" type="integer">
  The number of results returned in this page.
</ResponseField>

<ResponseField name="Resources" type="object[]">
  The list of groups. Each group has the same shape as the [Get a SCIM group](/rest-api/scim/get-group-by-id) response. When `excludedAttributes=members` is specified, the `members` field is omitted entirely from each group object.
</ResponseField>

<ResponseExample>
  ```json 200 theme={"system"}
  {
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
    "totalResults": 2,
    "startIndex": 1,
    "itemsPerPage": 2,
    "Resources": [
      {
        "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
        "id": "b5d3f8a1-c920-47e6-8b4d-3f17a9c82e50",
        "displayName": "Engineering",
        "members": [
          {
            "value": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
            "$ref": "/scim/v2/Users/3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47"
          }
        ],
        "meta": {
          "resourceType": "Group",
          "created": "2024-01-01T00:00:00.000Z",
          "lastModified": "2024-01-01T00:00:00.000Z"
        }
      }
    ]
  }
  ```
</ResponseExample>