---
title: "projection.read: List the note's objects and their ids — Note kit command — Kition"
description: "Lists the note's sections, tasks, tables, properties and links with the ids this session gives them (`section:3`, `task:2`), their label and first line, in document order by kind; `kinds` limits the list. Section commands take a section's id as `section`, `task.toggle` a task's as `task`, and receipts and `others` name what changed by these ids. An id follows its object through edits (a section renamed or moved keeps it) while the note stays open; it is never written into the file."
canonical: "https://developer.kition.ai/docs/kits/note/commands/projection.read"
---

> Canonical HTML: [https://developer.kition.ai/docs/kits/note/commands/projection.read](https://developer.kition.ai/docs/kits/note/commands/projection.read)

# projection.read

**List the note's objects and their ids.** Lists the note's sections, tasks, tables, properties and links with the ids this session gives them (`section:3`, `task:2`), their label and first line, in document order by kind; `kinds` limits the list. Section commands take a section's id as `section`, `task.toggle` a task's as `task`, and receipts and `others` name what changed by these ids. An id follows its object through edits (a section renamed or moved keeps it) while the note stays open; it is never written into the file.

- Kit: Note 0.3.0 (Markdown (.md)); reference: [Note kit commands](https://developer.kition.ai/docs/kits/note.md)
- Changes the document: no

## Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `kinds` | `("section" \| "task" \| "table" \| "property" \| "link")[]` | no | Only these kinds; all by default. |

## Call through note_run

```text
note_run {
  "path": "<file>.md",
  "steps": [{ "command": "projection.read" }]
}
```

The required parameters, with placeholders for their types: not a tested example. Optional: `kinds`. note_run answers the step’s result in `completed[i].result`.

## Result

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `objects` | `object[]` | yes | The objects, sections first, each kind in document order. |

```json
{
  "additionalProperties": false,
  "properties": {
    "objects": {
      "description": "The objects, sections first, each kind in document order.",
      "items": {
        "additionalProperties": false,
        "properties": {
          "done": {
            "description": "Whether a task is checked.",
            "type": "boolean"
          },
          "id": {
            "description": "The object's id this session: section:3, task:2, table:1, property:1, link:4.",
            "type": "string"
          },
          "kind": {
            "description": "Its kind.",
            "enum": [
              "section",
              "task",
              "table",
              "property",
              "link"
            ],
            "type": "string"
          },
          "label": {
            "description": "How it reads: a heading path joined by ›, a task's text, a table's header cells, a property key, a link's destination.",
            "type": "string"
          },
          "line": {
            "description": "Its first line, from 1.",
            "type": "integer"
          },
          "path": {
            "description": "A section's heading path.",
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "kind",
          "label",
          "line"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "objects"
  ],
  "type": "object"
}
```

## Parameter schema

```json
{
  "additionalProperties": false,
  "properties": {
    "kinds": {
      "description": "Only these kinds; all by default.",
      "items": {
        "enum": [
          "section",
          "task",
          "table",
          "property",
          "link"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}
```

Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9).
