SLslite

Return a note

Changed on

Return a note by id

get/notes/{noteId}

Request

  • Base URL
    https://api.slite.com/v1
  • Auth
    HTTP bearer

Path parameters

noteIdstring required

Note id to return

Query parameters

format'md' | 'html' | 'sliteml'

Format of the content to return (Markdown, Html, or SliteML)

css'inline' | 'none'

For html export: inline embeds the full Slite stylesheet (self-contained, larger payload); none omits it so the consumer supplies its own CSS (much smaller payload).

For html format only: whether to inline the Slite stylesheet (inline, default) or omit it so you supply your own CSS (none, much smaller payload). Ignored for other formats.

compactboolean

For sliteml format only: when true, returns the compact serialization (standard markdown for common blocks, XML only for rich Slite blocks) instead of the verbose full-tag XML. Smaller payload, recommended for new integrations, and accepted as-is by the write endpoints. Ignored for other formats.

Response

Ok

reviewState'Verified' | 'Outdated' | 'VerificationRequested' | 'VerificationExpired'
archivedAtstring date-time nullable required

Date of the archiving of the note (null if not archived)

lastEditedAtstring date-time required

Date of the last edition of the note

updatedAtstring date-time required

Date of the last update of the note

createdAtstring date-time required

Date of the creation of the note

columnsstring[]

If note is in a collection, it will contain its column names

attributesstring[]

If note is in a collection, it will contain its attributes ordered by column

urlstring required

Url to the note

listPositionnumber double nullable

Position of the note among its siblings, matching the order shown in the Slite sidebar. Higher values come first (top of the sidebar). By default it is seeded from the creation date, so freshly created docs appear at the top; manual reordering overrides it. Combine with orderBy=listPosition_DESC on the children endpoint to reproduce the sidebar order. Writable via the listPosition body parameter of the create and update endpoints.

parentNoteIdstring nullable required

Parent note id of the current note. It can be null if it's a root note.

iconColorstring nullable

Optional icon color for the note.

iconShapestring nullable

Optional icon identifier for the note.

titlestring required

Title of the note

idstring required

Id of the note

contentstring blob required

Content of the note in Markdown, Html, or SliteML

Changes