---
title: "Search Groups"
method: POST
path: "/Groups/.search"
tags: ["Groups Endpoint"]
---

# Search Groups

`POST /Groups/.search`

## Request

- Base URL: `https://api.asgardeo.io/t//scim2`
- URL: `https://api.asgardeo.io/t//scim2/Groups/.search`
- Auth: OAuth 2
  - Client credentials
- TypeScript: <https://skmtc.dev/ballerina-platform/apis/scim-2-0-api/docs/Groups/.search/post.ts> (a function with typed inputs; its response is checked against the schema)

This API returns groups according to the specified filter, sort, and pagination parameters.

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

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

## Request body

- GroupSearchRequestObject
  - `schemas` string[], required
  - `startIndex` integer
  - `filter` string

## Response `200`

Valid groups are found / Valid groups are not found

- GroupSearchResponseObject
  - `totalResults` integer
  - `startIndex` integer
  - `itemsPerPage` integer
  - `schemas` string[]
  - `Resources` GroupOb[]
    - `displayName` string
    - `meta` object
      - `created` string
      - `location` string
      - `lastModified` string
    - `members` object[]
      - `$ref` string
      - `display` string
      - `value` string
    - `roles` object[]
      - `$ref` string
      - `display` string
      - `value` string
    - `id` string

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

## Changes

- **2026-07-17** `7978594f207e`: 2 breaking
  - the request property `schemas` became required
  - the `schemas` request property type changed from `object` to `array`
- **2025-08-14** `d290ee2c70fc`: 1 breaking, 1 info
  - the `schemas` request property type changed from `array` to `object`
  - the request property `schemas` became optional

[Operation history](https://skmtc.dev/ballerina-platform/apis/scim-2-0-api/changes/Groups/.search/post.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.dev/ballerina-platform/apis/scim-2-0-api/revisions/7978594f207e?raw)