---
title: "Get a note by path"
method: GET
path: "/api/notes/*path"
tags: ["Notes"]
---

# Get a note by path

`GET /api/notes/*path`

## Request

- Base URL: `https://api.engram.page`
- URL: `https://api.engram.page/api/notes/*path`
- Auth: HTTP bearer

Returns the full note (including content) at the given slash-separated path, or 404 if no note exists there.

## Path parameters

- `path` string, required

## Response `200`

Note

- Note
  - `content` string
  - `content_hash` string, nullable
  - `description` string, nullable: OKF frontmatter `description` field
  - `fm_created` string, date-time, nullable: OKF frontmatter `created`/`date` field
  - `fm_timestamp` string, date-time, nullable: OKF frontmatter `timestamp`/`modified`/`updated` field
  - `folder` string, nullable
  - `id` string, uuid, nullable
  - `links` NoteLink[]: Outgoing link/embed edges, resolved. Wikilink and markdown syntax alike.
    - `alias` string, nullable: Display text: `[[target|alias]]`'s alias, or `[label](target)`'s label.
    - `anchor` string, nullable: Heading/block reference: `[[target#anchor]]` or `[x](target#anchor)`.
    - `dangling` boolean, required: True when the target could not be resolved.
    - `link_type` string, required: "wikilink" or "embed" — whether the link EMBEDS its target. Not the source syntax; markdown-form links carry these same two values.
    - `target_attachment_id` string, uuid, nullable
    - `target_note_id` string, uuid, nullable
    - `target_path` string, nullable: Resolved note path.
    - `target_text` string, required: The link target, percent-DECODED. `[[Target]]` and `[x](Target.md)` both yield `Target`/`Target.md` here — not the literal source bytes.
  - `mtime` number, float: Client mtime (epoch seconds)
  - `parse_reason` object, nullable: Present when parse_status is "degraded": {code, message, detail}
  - `parse_status` 'ok' | 'degraded', nullable: Frontmatter parse outcome
  - `path` string, required
  - `resource` string, nullable: OKF frontmatter `resource` field
  - `tags` string[]
  - `title` string, nullable
  - `type` string, nullable: OKF frontmatter `type` field
  - `updated_at` string, date-time, nullable
  - `version` integer, nullable

## Other responses

- `404`: No such note

---

[API](https://skmtc.dev/engram/apis/engram-api.md) · [All operations](https://skmtc.dev/engram/apis/engram-api/llms.txt) · [OpenAPI document](https://skmtc.dev/engram/apis/engram-api/revisions/8c4c2eec29dc?raw)