---
title: "List All Groups"
method: GET
path: "/api/v2/groups"
tags: ["Groups"]
---

# List All Groups

`GET /api/v2/groups`

## Request

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

This endpoint returns all Groups that exist in your organization.

#### Available filter fields:
  - `name`
  - `type`
  - `memberQueryErrorFlags`

#### Sample Request

```
  curl -X GET \
  https://console.jumpcloud.com/api/v2/groups \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: {API_KEY}'
```

## Query parameters

- `fields` string[]
- `filter` string[]
- `limit` integer
- `skip` integer
- `sort` string[]

## Headers

- `x-org-id` string
- `x-unfiltered-total-count` integer

## Response `200`

OK

- Group[]
  - `attributes` GraphAttributes, nullable: The graph attributes.
  - `description` string: Description of a Group
  - `email` string: E-mail address associated with a Group
  - `id` string: ObjectId uniquely identifying a Group.
  - `name` string: Display name of a Group.
  - `organizationObjectId` string, nullable: id of the organization owning this group
  - `type` 'policy_group' | 'system_group' | 'user_group': The group type.
  - `memberQueryErrorFlags` string[]: Group error flags indicating errors encountered during member query evaluation. Possible flag values: - CYCLE: A cyclic dependency was detected in group membership - INVALID_GROUP_REFERENCE: The group reference is invalid or does not exist The `member_query_error_flags` as a field supports array-based filtering: - `CO`: Contains Overlap - check if array overlaps with the specified array (use `["VALUE"]` for single value) - `NCO`: Not Contains Overlap - check if array does not overlap - `EQ`: Exact array match - `NE`: Not equal to array - `IN`: Array contains any of the specified values **Note:** Single `value` is converted to array `["value"]``.

## Other responses

- `default`: Unexpected error

---

[API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)