Notes

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Create, retrieve, update, delete, and publish personal notes and reflections.

List notes owned by the user. This API contains pagination. Read more about [pagination](/#pagination)

Add a new note.

Retrieve notes by a specific verse.

Retrieve notes by attached entity.

Get the count of notes within a range of verses.

Retrieve notes by a range of verses.

Retrieve a note by its ID.

Update a note by its ID.

Delete a note by its ID.

Publish a note to QR.