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

# Get Groups list

`GET /api/groups`

Returns groups

## Query parameters

- `offset` integer — Offset index of results for paggination purposes
- `limit` integer
- `sourcePartnerId` string
- `name` string

## Response `200`

Groups list

- object[]
  - `id` string, uuid
  - `name` string
  - `parentId` string, uuid, nullable — Parent Groups id.
  - `creator` object
    - `id` string, uuid — Group creators id
    - `name` string
    - `company` string
  - `visibility` 'public' | 'private'
  - `sourcePartnerId` string
  - `createdAt` string
  - `updatedAt` string
  - `deletedAt` string

## Changes

- **2018-08-22** `a34f34aacc16` — 1 info
  - endpoint added
- **2018-08-20** `ba36cd387928` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/citizenos/apis/citizenos-api/changes/api/groups/get.md)

---

[API](https://skmtc.dev/citizenos/apis/citizenos-api.md) · [All operations](https://skmtc.dev/citizenos/apis/citizenos-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/citizenos/citizenos-api/revisions/ca28908e6b75/schema)