# ink.branchline.listAuthorPlantings

> 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.listAuthorPlantings)
- [Documentation](https://lexicon.garden/lexicon/did:plc:brvu7akhdvsqcomb67pafw25/ink.branchline.listAuthorPlantings/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:brvu7akhdvsqcomb67pafw25/ink.branchline.listAuthorPlantings/examples)

## Definitions

### `ink.branchline.listAuthorPlantings`

**Type**: `query`

List trees planted by an author. A planting is a root bud (depth 0) authored by `actor`; each entry reports the root AT-URI and the height of the tallest branch descended from it.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actor` | `string` (did) | Yes | DID of the author whose plantings 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. |
| `plantings` | `array` | Yes |  |

### `ink.branchline.listAuthorPlantings#plantingView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `root` | `string` (at-uri) | Yes | AT-URI of the root bud the author planted. |
| `treeHeight` | `integer` | Yes | Length of the longest root-to-leaf path in this tree (1 when the root has no children). |

## Raw Schema

```json
{
  "id": "ink.branchline.listAuthorPlantings",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "plantings"
          ],
          "properties": {
            "cursor": {
              "type": "string",
              "description": "Opaque pagination token for the next page. Absent when there are no more results."
            },
            "plantings": {
              "type": "array",
              "items": {
                "ref": "#plantingView",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "actor"
        ],
        "properties": {
          "actor": {
            "type": "string",
            "format": "did",
            "description": "DID of the author whose plantings 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 trees planted by an author. A planting is a root bud (depth 0) authored by `actor`; each entry reports the root AT-URI and the height of the tallest branch descended from it."
    },
    "plantingView": {
      "type": "object",
      "required": [
        "root",
        "treeHeight"
      ],
      "properties": {
        "root": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the root bud the author planted."
        },
        "treeHeight": {
          "type": "integer",
          "minimum": 1,
          "description": "Length of the longest root-to-leaf path in this tree (1 when the root has no children)."
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```