---
title: "Get user groups"
method: GET
path: "/v2/user-groups/settings"
tags: ["User Groups"]
---

# Get user groups

`GET /v2/user-groups/settings`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/user-groups/settings`
- Auth: API key in header `X-AUTH-TOKEN`
- TypeScript: <https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/user-groups/settings/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `partitionId` string, required
- `accountId` string, required
- `groupId` string
- `userId` string

## Response `200`

Successful operation

- UserGroupResponse
  - `partitionId` string
  - `accountId` string
  - `groupId` string
  - `groupName` string
  - `groupDescription` string
  - `userIds` object[]
    - `userId` string
    - `endUserType` string

## Other responses

- `204`: No content – operation completed successfully
- `400`: Invalid request
- `401`: Unauthorized
- `404`: Not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)