wiki.lichen.listNotes

lichen.wiki

Documentation

List a public wiki's notes, each with its head revision. Compare latestRevisionUri with what you hold, then call getNote for the notes that changed.

main query

List a public wiki's notes, each with its head revision. Compare latestRevisionUri with what you hold, then call getNote for the notes that changed.

Parameters

cursor string Optional

No description available.

includeDeleted boolean Optional

Also list deleted notes, each marked by its status.

limit integer Optional

No description available.

wiki string at-uri Required

AT-URI of the wiki record.

Output

Encodingapplication/json
cursor string Optional

Absent on the last page.

notes array Required

No description available.

Errors

NotFound
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Also list deleted notes, each marked by its status.
AT-URI of the wiki record.
View raw schema 
{
  "description": "List a public wiki's notes, each with its head revision. Compare latestRevisionUri with what you hold, then call getNote for the notes that changed.",
  "errors": [
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Absent on the last page.",
          "type": "string"
        },
        "notes": {
          "items": {
            "ref": "#noteView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "notes"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "type": "string"
      },
      "includeDeleted": {
        "default": false,
        "description": "Also list deleted notes, each marked by its status.",
        "type": "boolean"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "wiki": {
        "description": "AT-URI of the wiki record.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "wiki"
    ],
    "type": "params"
  },
  "type": "query"
}
noteView object

No description available.

Properties

latestRevisionUri string at-uri Required

The head revision, the same value getNote returns. Compare it with what you hold to spot a change. Set it as parentRevision to write.

slug string Required

No description available.

status string Optional

Present on a deleted note, which is listed only with includeDeleted.

Known values: live, deleted
title string Required

No description available.

updatedAt string datetime Required

The head revision's own timestamp, so appviews holding the same history agree. An unusable stamp falls back to our ingest time.

uri string at-uri Required

AT-URI of the note record. The rkey is a TID, so read it from here or address the note by wiki and slug.

View raw schema 
{
  "properties": {
    "latestRevisionUri": {
      "description": "The head revision, the same value getNote returns. Compare it with what you hold to spot a change. Set it as parentRevision to write.",
      "format": "at-uri",
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "status": {
      "description": "Present on a deleted note, which is listed only with includeDeleted.",
      "knownValues": [
        "live",
        "deleted"
      ],
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "updatedAt": {
      "description": "The head revision's own timestamp, so appviews holding the same history agree. An unusable stamp falls back to our ingest time.",
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "description": "AT-URI of the note record. The rkey is a TID, so read it from here or address the note by wiki and slug.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "uri",
    "slug",
    "title",
    "latestRevisionUri",
    "updatedAt"
  ],
  "type": "object"
}

Lexicon Garden

@