Notes

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

• Use prelive.quran.com for auth-related testing.
• Use prelive.quranreflect.org for Quran Reflect paths where applicable.
• Do not mix production sessions or production user data with pre-live testing.

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

📄️ Get all notes

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

📄️ Add note

Add a new note.

📄️ Get notes by verse

Retrieve notes by a specific verse.

📄️ Get notes by attached entity

Retrieve notes by attached entity.

📄️ Get notes count within verse range

Get the count of notes within a range of verses.

📄️ Get notes by verse range

Retrieve notes by a range of verses.

📄️ Get note by ID

Retrieve a note by its ID.

📄️ Update note by ID

Update a note by its ID.

📄️ Delete note by ID

Delete a note by its ID.

📄️ Publish note

Publish a note to QR.