Bookmarks

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.

Save, list, retrieve, and remove user bookmarks for Quran content.

📄️ Add user bookmark

Add or update a bookmark by details. Omit `isReading` to create or update a regular standalone bookmark. Set `isReading=true` to set the user's singleton reading bookmark and replace any previous reading bookmark. Set `isReading=false` or `null` to mark this bookmark as non-reading. For Quran.com-style saved or favorite ayah bookmarks, use `POST /v1/collections/__default__/bookmarks`.

📄️ Get user bookmarks

Get all bookmarks. This includes bookmarks belonging to a collection.

📄️ Delete Bookmark

Delete a standalone bookmark by id. This endpoint fully removes orphan bookmarks only. If the bookmark belongs to the virtual Favorites collection or any custom collection, it is not removed; this endpoint only sets `isReading` to `false` and leaves the bookmark attached to those collections. To remove it from Favorites or a custom collection, use the corresponding collection delete endpoint instead.

📄️ Get bookmarks within a range of Ayahs

Get all bookmarks within a specific Ayahs range.

📄️ Get bookmark

Get a bookmark by details

📄️ Get bookmark collections

Get named collection IDs for a bookmark by bookmark details. Pass `includeDefault=true` to also append `__default__` when the bookmark belongs to Favorites.