---
title: "List groups"
method: GET
path: "/iam/v1/groups"
tags: ["Groups"]
---

# List groups

`GET /iam/v1/groups`

## Request

- Base URL: `https://your-environment.ataccama.one/api`
- URL: `https://your-environment.ataccama.one/api/iam/v1/groups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/docs/iam/v1/groups/get.ts> (a function with typed inputs; its response is checked against the schema)

List the groups in the group hierarchy.

## Query parameters

- `after` string
- `size` integer
- `parentUrn` string: A URN identifying a Group resource in the IAM API, or the literal "null", which matches groups that have no parent. The literal is needed because omitting the value means "do not filter by parent" rather than "parent is null". Format: urn:ata:{tenant}:iam:group:{uuid} Example values: - null - urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000
- `name` string
- `sort` string[]

## Response `200`

Paginated list of groups.

- object
  - `meta` PaginationMetadata, required
    - `next` string: Encoded string representing the next page. Omitted if there are no more pages.
    - `total` integer: Total number of items available across all pages.
  - `data` Group[], required
    - `urn` string, uri, required: A URN identifying a group resource in the IAM API. To find a group's URN, use the Groups endpoints of the IAM API. Format: urn:ata:{tenant}:iam:group:{uuid} Example: urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000.
    - `parentUrn` string, uri: A URN identifying a group resource in the IAM API. To find a group's URN, use the Groups endpoints of the IAM API. Format: urn:ata:{tenant}:iam:group:{uuid} Example: urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000.
    - `name` string, required: Name of the group.
    - `description` string: Human-readable description of the group's purpose.

## Other responses

- `400`: Bad request. The request parameters or body are invalid.
- `403`: Forbidden. You do not have permission to access the requested resource.

---

[API](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api.md) - [All operations](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ataccama/apis/ataccama-one-agentic-data-trust-platform-public-api/revisions/46f16e0487f8?raw)