---
title: "Batch Get Groups"
method: GET
path: "/v1alpha2/organizations/{organization}/groups:batchGet"
tags: ["ClientService"]
---

# Batch Get Groups

`GET /v1alpha2/organizations/{organization}/groups:batchGet`

## Request

- Base URL: `https://api.thirdfort.dev/client/api`
- URL: `https://api.thirdfort.dev/client/api/v1alpha2/organizations/{organization}/groups:batchGet`
- Auth: HTTP bearer

Retrieves multiple Groups by their resource names in a single request. All names must be in the Organization specified by parent. Maximum of 100 groups can be retrieved per request.

## Path parameters

- `organization` string, required

## Query parameters

- `names` string[], required
- `view` 'GROUP_VIEW_UNSPECIFIED' | 'GROUP_VIEW_BASIC' | 'GROUP_VIEW_FULL' | 'GROUP_VIEW_NAME_ONLY'

## Response `200`

A successful response.

- BatchGetGroupsResponse: Response message for [ClientService.BatchGetGroups](#/operations/ClientService_BatchGetGroups).
  - `groups` Group[]: The [Groups](#/schemas/Group) requested.
    - `name` string: The unique resource name of the group. This field is system-generated and immutable.
    - `displayName` string, required: Human-readable group name.
    - `email` string: Optional shared contact email address for the group.
    - `notificationBehaviour` 'NOTIFICATION_BEHAVIOUR_UNSPECIFIED' | 'SEND_TO_GROUP_EMAIL' | 'SEND_TO_MEMBERS' | 'SEND_TO_GROUP_EMAIL_AND_MEMBERS': Determines where notifications for a [Group](#/schemas/Group) are delivered. - SEND_TO_GROUP_EMAIL: Send notifications to the group's shared email address only. - SEND_TO_MEMBERS: Send notifications to every member of the group individually. - SEND_TO_GROUP_EMAIL_AND_MEMBERS: Send notifications to both the group's shared email address and every member.
    - `members` string[]: The member [Users](#/schemas/User) of the group.
    - `roleBindings` RoleBinding[]
      - `principal` string, required: The name of the principal this role binding applies to, in the canonical form for its type e.g. organizations/foo/users/bar. Valid types are: [User](#/schemas/User), [Group](#/schemas/Group) (both assignable via CreateRoleBinding), and integrations (e.g. partners/foo/integrations/1), whose bindings are managed by the system when an integration is set up.
      - `role` 'ROLE_UNSPECIFIED' | 'role_global_admin' | 'role_organization_admin' | 'role_team_admin' | 'role_team_creator' | 'role_team_viewer' | 'role_team_approver' | 'role_team_manual_task_analyst' | 'role_ai_chat_usage' | 'role_partner_integration' | 'role_organization_integration' | 'role_complyadvantagesetting_admin' | 'role_screening_configuration_admin' | 'role_support' | 'role_tech' | 'role_global_viewer' | 'role_global_role_admin' | 'role_global_monitoring_admin' | 'role_organization_monitoring_viewer' | 'role_team_review_admin' | 'role_team_review_initiator' | 'role_team_reviewer' | 'role_team_manual_task_admin' | 'role_organization_compliance_admin' | 'role_advanced_aml_user' | 'role_secure_share_viewer' | 'role_team_integration' | 'role_organization_creator', required: Role defines the permissions that can be assigned via a RoleBinding.
      - `resource` string, required

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/thirdfort/apis/thirdfort-client-api-preview.md) - [All operations](https://skmtc.dev/thirdfort/apis/thirdfort-client-api-preview/llms.txt) - [OpenAPI document](https://skmtc.dev/thirdfort/apis/thirdfort-client-api-preview/revisions/3446b9aefa90?raw)