GET/api/v1/documents/{slug}/comments

List comments

The comment threads on a page or markdown document you can read, with their messages, what each points at (anchor: quoted text, a block or the page; anchor_status is changed when the text was edited away, with original), and what you may do (can). Signed in, or anyone when the owner shows comments publicly. status filters open or resolved; mine keeps threads you're in.

Token optional240 per minute per IPMCP: list_comments

Guide: Comments

Code samples and Try it

Path parameters

#
  • slugstringRequired

    The document's address: the part after markdrop.in/.

Query parameters

#
  • status"open" | "resolved" | "all"

    Default "all".

  • mineboolean

    Default false.

Headers

#
  • X-Read-Passwordstring

    The password of a password-protected document.

  • X-Markdrop-Workspacestring

    A workspace's id: answer only if the document is in that workspace, else 404. Workspace domains send it; you rarely need it.

Responses

#
  • 200OK.
  • 401Sign in to see comments (code signin).
  • 403Comments are off for this item (code comments_off).
  • 404No such document, or it can't have comments (code comments_unavailable: encrypted, a file, or no owner).
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
Did this page help?