# List groups

`GET /v1/groups`

Requires an API key with the `groups:read` scope. [About keys and scopes](/docs/api/authentication)

Returns groups in this organization with their current member counts. Results are cursor-paginated: pass `meta.pagination.nextCursor` back as `cursor` until it comes back `null`. The cursor is opaque — do not construct or parse one.

## Query parameters

- `limit` (integer, optional, min > 0, max 100, default `20`)
- `cursor` (string, optional, 1–2048 characters)
- `name` (string, optional, 1–255 characters) — Partial, case-insensitive name match.
- `sort` (string, optional, one of `name`, `-name`, `createdAt`, `-createdAt`, default `"-createdAt"`) — Field to sort by; a leading `-` sorts descending.

## Returns

Returns `200 OK` with a list of `Group` objects in `data`, and the next page's cursor in `meta` (see [pagination](/docs/api/pagination)). Otherwise returns an error; [Errors](/docs/api/errors) lists every code and which to retry.

- `id` (string, required, uuid)
- `name` (string, required)
- `description` (string | null, required)
- `memberCount` (integer, required, min 0, max 9007199254740991) — Contacts currently in the group.
- `createdAt` (string, required, date-time)
- `updatedAt` (string, required, date-time)

## Example

```bash
curl https://api.kirora.io/v1/groups \
  -H "Authorization: Bearer $KIRORA_API_KEY"
```

Response `200`:

```json
{
  "data": [
    {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "name": "Weekend specials",
      "description": "description_example",
      "memberCount": 0,
      "createdAt": "2030-03-14T09:30:00Z",
      "updatedAt": "2030-03-14T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}
```