---
title: "List the caller's groups, cursor-paginated, newest first. System groups (e.g. Public Square) appear regardless of membership, with `role: null` and `isMember: false` (issue #117/#118)."
method: GET
path: "/groups"
tags: ["Groups"]
---

# List the caller's groups, cursor-paginated, newest first. System groups (e.g. Public Square) appear regardless of membership, with \`role: null\` and \`isMember: false\` (issue #117/#118).

`GET /groups`

## Request

- Base URL: `https://whatareyoudo.ing/api/v1`
- URL: `https://whatareyoudo.ing/api/v1/groups`
- Auth: HTTP bearer

## Query parameters

- `limit` string
- `cursor` string
- `q` string: Substring match on the group name.
- `role` 'owner' | 'admin': Only groups the caller runs: `owner` for the ones they own, `admin` for owner or admin.

## Response `200`

OK

- object
  - `data` GroupListItem[], required
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable, required
    - `groupType` 'personal' | 'shared' | 'system', required
    - `role` 'owner' | 'admin' | 'member', required
    - `memberCount` integer, required
    - `diaryCount` integer, required
    - `createdAt` string, required
    - `isPublic` boolean, required: Published to the world by its owner.
    - `publicFinance` boolean, required: Whether a published group's Finance is published with it.
  - `pagination` object, required
    - `nextCursor` string, nullable, required
    - `hasNext` boolean, required
    - `limit` integer, required
    - `totalCount` integer
  - `meta` object, required
    - `requestId` string, required

---

[API](https://skmtc.dev/whatareyoudo/apis/whatcha-api.md) · [All operations](https://skmtc.dev/whatareyoudo/apis/whatcha-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whatareyoudo/apis/whatcha-api/revisions/48dd8a54abea?raw)