---
title: "Get a list of groups"
method: GET
path: "/authorization/groups"
tags: ["Authorization"]
---

# Get a list of groups

`GET /authorization/groups`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/authorization/groups`
- Auth: none declared

Returns a list of groups.

## Query parameters

- `multiContains` IapAuthorizationCommonGroupsQuery
  - `name` string
  - `provenance` string
  - `description` string
- `multiEquals` IapAuthorizationCommonGroupsQuery
  - `name` string
  - `provenance` string
  - `description` string
- `multiStartsWith` IapAuthorizationCommonGroupsQuery
  - `name` string
  - `provenance` string
  - `description` string
- `inactive` boolean: Setting for whether group is active or not
- `skip` integer: Number of results to skip. Used for pagination.
- `limit` integer: Number of results to return. Used for pagination.
- `sort` 'name': Field to sort by. Default is name.
- `order` '-1' | '1': The sort direction: 1 for ascending or -1 for descending.
- `refresh` boolean

## Response `200`

The groups matching the specified query.

- AuthorizationGetGroupsResponse200
  - `results` IapGroupsSchema: This is the schema for an IAP group stored in Mongo
    - `provenance` string, required: AAA provider where group originated
    - `name` string, required: Name of group
    - `description` string, required: Description of group
    - `memberOf` IapGroupsSchemaMemberOfItems[], required: Parent groups which this group is a part of
      - `aaaManaged` boolean: Whether group comes from an external AAA or not
      - `groupId` string: String representation of a MongoDB ObjectId
    - `assignedRoles` IapGroupsSchemaAssignedRolesItems[], required: Roles assigned to this group
      - `roleId` string: String representation of a MongoDB ObjectId
    - `inactive` boolean, required: Setting for whether group is active or not
    - `_meta` IapGroupsSchemaMeta: Metadata for group
      - `created` string: When the group was created
      - `updated` string: When the group was last updated
  - `total` integer: The total number of documents

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)