Skip to main content

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.

Version: 1.0.0

User-related APIs

Quran.Foundation user-related APIs enable your app to seamlessly integrate with Quran.Foundation's user-centric features, providing access to personalized notes, bookmarks, goals, streaks, reading sessions, and more. This differentiates them from content APIs that focus on non-user-specific resources like translations, tafsirs, and verses.

How to get access​

We are using OAuth2 flows to authenticate and authorize requests. To get started, you need to get an access token to make requests to our APIs. Then follow the steps mentioned here.

For web applications, the recommended integration pattern is backend token exchange plus backend or server-side proxy calls to User APIs. Your app can keep the user session in secure server storage or httpOnly cookies, while your backend injects x-auth-token and x-client-id on outbound requests to Quran.Foundation APIs.

Pagination​

We are using cursor based pagination. The pagination query params consist of first,after, before and last.

Example

  • first: 10 will give you first 10 items

  • first: 10, after: xyz will give you first 10 items after the item with id xyz

  • last: 10 will give you the last 10 items

  • last: 10, before: xyz will give you the last 10 items before the item with id xyz

    The only possible combinations are first + after or last + before. They should not be used together

Authentication​

The JWT access token required for accessing the endpoints.

Security Scheme Type:apiKey
Header parameter name:x-auth-token