Skip to main content

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

Get posts feed​

Retrieve a paginated feed of Quran Reflect posts, including reflections and lessons. Supports filtering by authors, tags, Quran references, groups, pages, and post types. Response items include engagement metadata such as likesCount, commentsCount, and recentComment when available. Use the dedicated comment endpoints to retrieve comment objects and totals. For ayah-by-ayah reads, use filter[references][0][chapterId], filter[references][0][from], and filter[references][0][to], and use filter[postTypeIds]=1 for reflections or filter[postTypeIds]=2 for lessons.

Query Parameters
    tab string

    Possible values: [newest, latest, following, draft, favorite, most_popular, only_room_members, public, feed, trending, popular]

    Feed tab type. feed shows personalized content, trending shows explore, and following shows posts from followed users.

    sortBy string

    Possible values: [latest, popular]

    languages number[]

    Comma-separated list of language IDs to filter posts by reflection language, for example languages=1,2.

    page number

    Possible values: >= 1

    Default value: 1

    Page number for pagination (default: 1).

    limit number

    Possible values: >= 1

    Default value: 20

    Number of posts per page (default: 20).

    filter[verifiedOnly] boolean

    Whether to limit the feed to verified contributors. Public ayah-by-ayah reads typically combine this with indexed reference filters such as filter[references][0][chapterId], filter[references][0][from], and filter[references][0][to].

    filter[referencesOperator] string

    Possible values: [OR, AND]

    Operator applied to multiple Quran reference filters.

    filter[tagsOperator] string

    Possible values: [OR, AND]

    Operator applied to multiple tag filters.

    filter[postTypeIds] number[]

    Comma-separated Quran Reflect post type IDs. Use 1 for reflections and 2 for lessons.

    filter[pages] string[]

    Comma-separated list of page subdomains to include.

    filter[groups] string[]

    Comma-separated list of group URLs to include.

    filter[references][0][to] number

    Possible values: >= 1

    Ending ayah number for reference filter index 0. For a single ayah, use the same value as from.

    filter[references][0][from] number

    Possible values: >= 1

    Starting ayah number for reference filter index 0. Pair with the matching chapterId and to values.

    filter[references][0][chapterId] number

    Possible values: >= 1

    Reference filter example for index 0. Use additional indices such as filter[references][1][chapterId] for more references.

    filter[tags] string[]

    Comma-separated list of tag values to include.

    filter[authors] string[]

    Comma-separated list of author identifiers to include.

Responses

Feed retrieved successfully with paginated posts

Schema
    total number required
    currentPage number required
    limit number required
    pages number required
    data object[] required
  • Array [
    • tags object[]
  • Array [
    • language string
    id number required
    name string
  • ]
    • references object[]
  • Array [
    • id string required
    from number
    to number
    chapterId number
  • ]
    • author object
    recentComment object
    id number required
    author object required
    postsCount number
    avatarUrls object required
    small string
    medium string
    large string
    id string required
    username string
    verified boolean

    Default value: false

    firstName string
    lastName string
    memberType number
    body string required
    createdAt date-time required
    room object nullable
    isAdmin object
    isOwner object
    isPublic object
    id number required
    subdomain string
    roomType string
    verified boolean

    Default value: false

    name string
    _group string
    mentions object[]
  • Array [
    • postsCount number
    avatarUrls object required
    small string
    medium string
    large string
    id string required
    username string
    verified boolean

    Default value: false

    firstName string
    lastName string
    memberType number
    locations object required
    followersCount number required
    displayName string
  • ]
    • isLiked boolean
    isByFollowedUser boolean
    isCommentedOn boolean
    isSaved boolean
    id number required
    authorId string required
    body string
    discussionId number
    draft boolean

    Default value: false

    createdAt date-time required
    updatedAt date-time required
    publishedAt date-time
    global boolean
    toxicityScore number
    reported boolean

    Default value: false

    views number
    removed boolean

    Default value: false

    verified boolean

    Default value: false

    roomPostStatus number

    Possible values: [0, 1, 2]

    Default value: 0

    @description 0: OnlyMembers, 1: Publicly, 2: AsRoom

    hidden boolean

    Default value: false

    commentsCount number required

    Default value: 0

    likesCount number

    Default value: 0

    viewsCount number

    Default value: 0

    languageId number
    languageName string
    moderationStatus number

    Possible values: [1, 2, 3, 4, 5, 6, 30]

    featured = 1, // Like Sticky posts, will be featured for a time period.Shown at top in feed and partner apps

    promoted = 2, // High quality content.Shown at top(after featured) in feed and partner apps

    normal = 3, // Default status, available in search, latest and popular tabs.In feed(if you're following the author)

    hidden = 4, // Visible only to author or moderators, or via private share link.

    private_note = 5, // Private notes, only visible to author or via private share link.These are the posts made "private" by moderators.

    requested_review = 6, // User requested the review, treat them has hidden.Only visible to author and moderators

    deleted = 30,

    reviewedAt date-time
    featuredAt date-time
    pushedUpAt date-time
    estimatedReadingTime number

    Default value: 0

    roomId number required
    postTypeId number required
    postTypeName string
  • ]
Loading...