Skip to main content

Get note by ID​

Retrieve a note by its ID.

Query Parameters
    withAttachedEntities boolean

    Default value: true

    Specifies whether to include attached entities in the response, defaults to true.

Responses

Request has been handled successfully.

Schema
    success boolean
    data object
    id string required

    The unique identifier of the note.

    createdAt date-time required

    The creation date of the note.

    updatedAt date-time required

    The last update date of the note.

    body string required

    Possible values: >= 6 characters and <= 10000 characters

    The main content of the note, must be between the specified minimum and maximum length.

    source string

    The source of the note.

    attachedEntities object[]

    An array of attached entities associated with the note.

  • Array [
    • entityId string required

    The unique identifier for the attached entity.

    entityType string required

    Possible values: [reflection]

    The type of the attached entity, must be one of the predefined NoteEntityType values.

    entityMetadata object

    Additional metadata for the attached entity.

  • ]
    • ranges string[]

    Possible values: Value must match regular expression ^(\d+):(\d+)-(\d+):(\d+)$

    An array of verse ranges associated with the note.

Loading...