# ink.branchline.listAuthorBookmarks

> Published by [branchline.ink](https://lexicon.garden/identity/did:plc:brvu7akhdvsqcomb67pafw25)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:brvu7akhdvsqcomb67pafw25/ink.branchline.listAuthorBookmarks)
- [Documentation](https://lexicon.garden/lexicon/did:plc:brvu7akhdvsqcomb67pafw25/ink.branchline.listAuthorBookmarks/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:brvu7akhdvsqcomb67pafw25/ink.branchline.listAuthorBookmarks/examples)

## Definitions

### `ink.branchline.listAuthorBookmarks`

**Type**: `query`

List bookmarks authored by an actor, newest first. Bookmarks are public records; any viewer may list them.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actor` | `string` (did) | Yes | DID of the author whose bookmarks to list. |
| `limit` | `integer` | No |  |
| `cursor` | `string` | No | Opaque pagination token returned by a prior call. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | Opaque pagination token for the next page. Absent when there are no more results. |
| `bookmarks` | `array` | Yes |  |

### `ink.branchline.listAuthorBookmarks#bookmarkView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes | The bookmark record AT-URI. |
| `createdAt` | `string` (datetime) | Yes |  |
| `subjectUri` | `string` (at-uri) | Yes | AT-URI of the bud this bookmark points at. |
| `subjectRootUri` | `string` (at-uri) | Yes | AT-URI of the root bud in the story tree the subject belongs to. |
| `subjectPathUris` | `array` | Yes | Ordered AT-URIs from the root bud to (and including) the subject bud. |

## Raw Schema

```json
{
  "id": "ink.branchline.listAuthorBookmarks",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "bookmarks"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "description": "Opaque pagination token for the next page. Absent when there are no more results."
            },
            "bookmarks": {
              "type": "array",
              "items": {
                "ref": "#bookmarkView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "actor"
        ],
        "properties": {
          "actor": {
            "type": "string",
            "format": "did",
            "description": "DID of the author whose bookmarks to list."
          },
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1
          },
          "cursor": {
            "type": "string",
            "description": "Opaque pagination token returned by a prior call."
          }
        }
      },
      "description": "List bookmarks authored by an actor, newest first. Bookmarks are public records; any viewer may list them."
    },
    "bookmarkView": {
      "type": "object",
      "required": [
        "uri",
        "subjectUri",
        "subjectRootUri",
        "subjectPathUris",
        "createdAt"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "The bookmark record AT-URI."
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "subjectUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the bud this bookmark points at."
        },
        "subjectRootUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the root bud in the story tree the subject belongs to."
        },
        "subjectPathUris": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "at-uri"
          },
          "description": "Ordered AT-URIs from the root bud to (and including) the subject bud."
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```