> ## 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 users

> Lists all SCIM users in the workspace, including active members and pending invites, 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: `userName`, `emails.value`, `id`, `name.givenName`, `name.familyName`, `active`. Supported operators: `eq`, `ne`, `co`, `sw`, `ew`. Example: `userName eq "john@example.com"`.
</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>

<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 users 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 users. Each user has the same shape as the [Get a SCIM user](/rest-api/scim/get-user-by-id) response.
</ResponseField>

<ResponseExample>
  ```json 200 theme={"system"}
  {
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
    "totalResults": 1,
    "startIndex": 1,
    "itemsPerPage": 1,
    "Resources": [
      {
        "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
        "id": "3a8f5b2c-9e14-4d7a-b832-1c6f85d90e47",
        "userName": "john.doe@example.com",
        "name": {
          "givenName": "John",
          "familyName": "Doe"
        },
        "emails": [
          {
            "value": "john.doe@example.com",
            "primary": true,
            "type": "work"
          }
        ],
        "active": true,
        "appRole": "member",
        "meta": {
          "resourceType": "User",
          "created": "2024-01-01T00:00:00.000Z",
          "lastModified": "2024-01-01T00:00:00.000Z"
        }
      }
    ]
  }
  ```
</ResponseExample>