Collections

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.

Organize bookmarks into user-managed collections.

📄️ Add collection

Create a new collection under user's account.

📄️ Get all collections

List collections owned by the user. This api contains pagination. Read more about [pagination](/docs/user_related_apis_versioned/user-related-apis#pagination)

📄️ Add collection Bookmark

Add a bookmark to a collection. Use `collectionId='__default__'` to add an ayah bookmark to the virtual Favorites collection used by Quran.com.

📄️ Delete collection bookmark by details

Delete a bookmark from a collection by bookmark details. Use `collectionId='__default__'` to remove a bookmark from the virtual Favorites collection. When successfully deleted, the bookmark itself is only detached from the collection unless it becomes an orphan.

📄️ Delete collection

Delete a an existing collection.

📄️ Get collection items by id

Get all resources that belong to an existing collection by collection id. Use `__default__` to fetch the virtual Favorites collection.

📄️ Update collection

Update an existing collection.

📄️ Delete collection bookmark by id

Delete a bookmark from a collection by bookmark ID. Use `collectionId='__default__'` to remove a bookmark from the virtual Favorites collection. When successfully deleted, the bookmark itself is only detached from the collection unless it becomes an orphan.

📄️ Get all collection items

Get all existing collections along with resources that belong to them.