---
title: "Search/List Users"
method: GET
path: "/scim/v2/Users"
tags: ["SCIM"]
---

# Search/List Users

`GET /scim/v2/Users`

Returns the list of users satisfying search criteria

## Query parameters

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

## Response `200`

Successful response

- ScimUserSearchResponse
  - `Resources` ScimUserResponse[] — User list
    - `active` boolean — User status
    - `addresses` ScimUserAddress[]
      - `country` string
      - `locality` string
      - `postalCode` string
      - `region` string
      - `streetAddress` string
      - `type` 'work', required
    - `emails` ScimEmail[], required
      - `type` 'work', required
      - `value` string, required
    - `externalId` string — External unique resource ID defined by provisioning client
    - `id` string — Unique resource ID defined by RingCentral
    - `name` ScimName, required
      - `familyName` string, required
      - `givenName` string, required
    - `phoneNumbers` ScimPhoneNumber[]
      - `type` 'work' | 'mobile' | 'other', required
      - `value` string, required
    - `photos` ScimPhoto[]
      - `type` 'photo', required
      - `value` string, required
    - `schemas` string[], required
    - `title` string — User title
    - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` ScimEnterpriseUser
      - `department` string
    - `userName` string, required — MUST be same as work type email address
    - `meta` ScimMeta — Resource metadata
      - `created` string, date-time
      - `lastModified` string, date-time
      - `location` string — Resource location URI
      - `resourceType` 'User' | 'Group' | 'ResourceType' | 'Schema'
  - `itemsPerPage` integer
  - `schemas` string[]
  - `startIndex` integer
  - `totalResults` integer

## Other responses

- `400` — Bad request
- `401` — Authorization failure
- `403` — Permissions denied
- `429` — Too many requests
- `500` — Internal server error

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)