Documents

Get a document

Returns one document owned by the authenticated user, including its markdown body. A document owned by another user returns 404.

get/api/v1/documents/{id}

Request

  • Base URL: https://mdflow.cz
  • URL: https://mdflow.cz/api/v1/documents/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Document UUID.

Response

Document details.

idstring uuid required
titlestring required
folder_idstring uuid required
is_publicboolean required
workspace_idstring uuid required

The workspace this document belongs to (via its folder).

path_stringstring required

Path segment names joined by " / ".

bodystring required

Markdown document body.

compounded_descriptionstring required

Labeled cascade of descriptions from the workspace down through each ancestor folder to this document's folder. Empty string when nothing in the chain has a description.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.