API Reference
Use this page when you already know what you are building and need endpoint-level request and response details.
If you do not have a Quran Foundation client yet, start with Request Access. If you are still choosing an app shape, start with the Developer Journey.
API Families
| API family | Use for | Authentication shape | Reference |
|---|---|---|---|
| Content APIs | Quran text, chapters, verses, translations, tafsir, audio, recitations, pages, juz, hizb, ruku, and manzil resources. | App credentials from your backend, or the JavaScript SDK server client. | Open Content APIs |
| Search APIs | Quran search queries and search result retrieval. | App credentials from your backend, or the JavaScript SDK server client. | Open Search APIs |
| User APIs | Bookmarks, collections, notes, reading sessions, goals, preferences, profiles, rooms, posts, comments, and tags. | OAuth2 user session token plus client ID. | Open User APIs |
| OAuth2 APIs | Authorization, token exchange, introspection, OIDC userinfo, and logout endpoints. | OAuth2 / OpenID Connect. | Open OAuth2 APIs |
| User APIs (Pre-live) | Upcoming user API behavior before it is promoted to production docs. | Pre-live OAuth2 user session token plus client ID. | Open Pre-live User APIs |
Reference Helpers
- Field Reference lists common content field selectors.
- OAuth2 Scopes lists user API scopes.
- Content APIs Quickstart explains the first backend Content API call.
- User APIs Quickstart explains signed-in user API calls.
