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

• 200
• 403
• 404
• 422
• 500

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

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.

{
  "success": true,
  "data": {
    "id": "asdasdqwe1231",
    "createdAt": "2023-01-21T07:28:13.023Z",
    "updatedAt": "2023-01-22T07:28:13.023Z",
    "body": "This is a sample note body.",
    "source": "we23412312weq",
    "attachedEntities": [
      {
        "entityId": "entity123",
        "entityType": "reflection",
        "entityMetadata": {
          "key": "value"
        }
      }
    ],
    "ranges": [
      "2:255-2:257"
    ]
  }
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ForbiddenError",
    "message": "Token expired"
  }
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "NotFoundError",
    "message": "The resource you're looking for does not exist"
  }
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ValidationError",
    "message": "`id` is required"
  }
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ServerError",
    "message": "Something went wrong"
  }
}

Loading...