Skip to main content
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.

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