---
title: "Get Groups"
method: GET
path: "/groups"
tags: ["Groups"]
---

# Get Groups

`GET /groups`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/groups`
- Auth: OAuth 2
  - Client credentials
  - Password
  - Token URL: `https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token`
- TypeScript: <https://skmtc.dev/unqork/apis/unqork-customer-api/docs/groups/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns group objects. This is a paged endpoint (see Paging).
### Authorization Required:
  - Designer Administrator

## Query parameters

- `limit` integer

## Response `200`

Groups

- Group[]
  - `name` string
  - `description` string
  - `type` 'role_descendents' | 'own_role_and_descendents' | 'ignore_role': See Group Administration screen for definitions

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/unqork/apis/unqork-customer-api.md) - [All operations](https://skmtc.dev/unqork/apis/unqork-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unqork/apis/unqork-customer-api/revisions/13dad4096373?raw)