# app.bivri.bookmark.listGroups

> Published by [lexicons.bivri.app](https://lexicon.garden/identity/did:plc:uqat5a7hrbww3snbbinxgwah)

✓ This is the authoritative definition for this NSID.

## Description

List bookmark groups. Requires authentication.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.bookmark.listGroups)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.bookmark.listGroups/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uqat5a7hrbww3snbbinxgwah/app.bivri.bookmark.listGroups/examples)

## Definitions

### `app.bivri.bookmark.listGroups`

**Type**: `query`

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No |  |
| `cursor` | `string` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `groups` | `array` | Yes |  |

### `app.bivri.bookmark.listGroups#bookmarkGroupView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `name` | `string` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `itemCount` | `integer` | No |  |

## Raw Schema

```json
{
  "id": "app.bivri.bookmark.listGroups",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "groups"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "groups": {
              "type": "array",
              "items": {
                "ref": "#bookmarkGroupView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string"
          }
        }
      }
    },
    "bookmarkGroupView": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "name",
        "createdAt"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "name": {
          "type": "string"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "itemCount": {
          "type": "integer"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "List bookmark groups. Requires authentication."
}
```