---
title: "Filter Users"
method: GET
path: "/Users"
tags: ["Users Endpoint"]
---

# Filter Users

`GET /Users`

This API returns users according to the filter, sort and pagination parameters. Pagination is not supported across user stores and LDAP multi-attribute group filtering. However, filtering is supported across multiple user stores.

 - <b>Scope(Permission) required:</b> ``internal_user_mgt_list``

 - <b>Flow type:</b> Client Credentials OAuth Flow

## Query parameters

- `attributes` string
- `excludedAttributes` string
- `filter` string
- `startIndex` integer
- `count` integer
- `domain` string

## Response `200`

Valid users are found / Valid users are not found

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

## Changes

- **2026-07-17** `7978594f207e` — 4 breaking
  - response property `Resources/items/emails/items/` list-of-types was widened by adding types `string` to media type `application/scim+json` of response `200`
  - the `Resources/items/roles` response's property type/format changed from `object`/`` to `array`/`` for status `200`
  - the `Resources/items/schemas` response's property type/format changed from `object`/`` to `array`/`` for status `200`
  - the `schemas` response's property type/format changed from `object`/`` to `array`/`` for status `200`
- **2025-08-05** `d290ee2c70fc` — 3 breaking, 1 info
  - the `Resources/items/roles` response's property type/format changed from `array`/`` to `object`/`` for status `200`
  - the `Resources/items/schemas` response's property type/format changed from `array`/`` to `object`/`` for status `200`
  - the `schemas` response's property type/format changed from `array`/`` to `object`/`` for status `200`
  - response property `Resources/items/emails/items/` list-of-types was narrowed by removing types `string` from media type `application/scim+json` of response `200`

[Change history](https://skmtc.dev/ballerina-platform/apis/scim-2-0-api/changes/Users/get.md)

---

[API](https://skmtc.dev/ballerina-platform/apis/scim-2-0-api.md) · [All operations](https://skmtc.dev/ballerina-platform/apis/scim-2-0-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ballerina-platform/scim-2-0-api/revisions/7978594f207e/schema)