Bookmarks

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.

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.