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.
Get related posts
Retrieve posts related to a given post by matching its Quran references with OR logic. Results are filtered by language preferences and ordered by popularity, excluding the source post.
Path Parameters
Source post ID used for related-post matching
Query Parameters
Possible values: >= 1
Number of posts per page (default: 8, max: 8)
Possible values: >= 1
Default value: 1
Page number for pagination (default: 1)
- 200
- 404
Related posts retrieved successfully with pagination metadata
Schema
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
data object[] required
reactionSummary object
Total reactions represented in counts.
counts object[] required
Nonzero counts ordered by descending count, then reaction identifier.
Number of non-banned reactors using this type.
The authenticated viewer’s reaction, or null for no reaction or an anonymous viewer.
sourceApp object
Display name of the partner app that created the post.
Absolute http(s) link to the partner app. When the app is configured with a reference URL template and the post has a Quran reference, this links to that reference in the app.
tags object[]
references object[]
recentComment object
author object required
avatarUrls object required
Default value: false
room object nullable
Deprecated content-visibility projection. Use privacy instead.
Possible values: [public, closed, private]
Default value: false
mentions object[]
avatarUrls object required
Default value: false
Default value: false
Default value: false
Default value: false
Default value: false
Possible values: [0, 1, 2]
Default value: 0
@description 0: OnlyMembers, 1: Publicly, 2: AsRoom
Default value: false
Default value: 0
Default value: 0
Default value: 0
Default value: 0
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,
Possible values: [1, 2, 100]
Moderator review state. 1 = reviewed, 2 = pending review, 100 = legacy. This is separate from post visibility, which is controlled by moderationStatus.
Default value: 0
{
"total": 10,
"currentPage": 1,
"limit": 10,
"pages": 1,
"data": [
{
"reactionSummary": {
"total": 18,
"counts": [
{
"reactionType": "reaction1",
"count": 12
}
],
"currentUserReaction": "reaction1"
},
"sourceApp": {
"name": "Example Partner App",
"url": "https://partner.example.com"
},
"tags": [
{
"language": "string",
"id": 0,
"name": "string"
}
],
"references": [
{
"id": "string",
"from": 0,
"to": 0,
"chapterId": 0
}
],
"author": {},
"recentComment": {
"id": 0,
"author": {
"postsCount": 0,
"avatarUrls": {
"small": "string",
"medium": "string",
"large": "string"
},
"id": "string",
"username": "string",
"verified": false,
"firstName": "string",
"lastName": "string",
"fullName": "string",
"memberType": 0
},
"body": "string",
"createdAt": "2026-11-13T03:19:57.526Z"
},
"room": {
"isAdmin": {},
"isOwner": {},
"privacy": "public",
"id": 0,
"subdomain": "string",
"roomType": "string",
"verified": false,
"name": "string",
"_group": "string"
},
"mentions": [
{
"postsCount": 0,
"avatarUrls": {
"small": "string",
"medium": "string",
"large": "string"
},
"id": "string",
"username": "string",
"verified": false,
"firstName": "string",
"lastName": "string",
"fullName": "string",
"memberType": 0,
"locations": {},
"followersCount": 0,
"displayName": "string"
}
],
"sourcePost": {},
"hasSourcePost": true,
"isSourcePostVisible": true,
"reReflectsCount": 0,
"isLiked": true,
"isByFollowedUser": true,
"isCommentedOn": true,
"isSaved": true,
"media": [
{}
],
"id": 0,
"authorId": "string",
"editSource": "string",
"privacySource": "string",
"body": "string",
"discussionId": 0,
"draft": false,
"createdAt": "2026-11-13T03:19:57.526Z",
"updatedAt": "2026-11-13T03:19:57.526Z",
"publishedAt": "2026-11-13T03:19:57.526Z",
"global": true,
"toxicityScore": 0,
"reported": false,
"views": 0,
"removed": false,
"verified": false,
"roomPostStatus": 0,
"hidden": false,
"commentsCount": 0,
"likesCount": 0,
"viewsCount": 0,
"readsCount": 0,
"languageId": 0,
"languageName": "string",
"moderationStatus": 1,
"reviewStatus": 1,
"reviewedAt": "2026-11-13T03:19:57.526Z",
"featuredAt": "2026-11-13T03:19:57.526Z",
"pushedUpAt": "2026-11-13T03:19:57.526Z",
"estimatedReadingTime": 0,
"roomId": 0,
"postTypeId": 0,
"postTypeName": "string",
"sourcePostId": 0
}
]
}
{
"total": 10,
"currentPage": 1,
"limit": 10,
"pages": 1,
"data": [
{
"reactionSummary": {
"total": 18,
"counts": [
{
"reactionType": "reaction1",
"count": 12
}
],
"currentUserReaction": "reaction1"
},
"sourceApp": {
"name": "Example Partner App",
"url": "https://partner.example.com"
},
"tags": [
{
"language": "string",
"id": 1,
"name": "string"
}
],
"references": [
{
"id": "string",
"from": 1,
"to": 1,
"chapterId": 1
}
],
"author": {},
"recentComment": {
"id": 1,
"author": {
"postsCount": 1,
"avatarUrls": {
"small": "string",
"medium": "string",
"large": "string"
},
"id": "string",
"username": "string",
"verified": false,
"firstName": "string",
"lastName": "string",
"fullName": "string",
"memberType": 1
},
"body": "string",
"createdAt": "2026-04-02T00:00:00.000Z"
},
"room": {
"isPublic": true,
"isAdmin": {},
"isOwner": {},
"privacy": "public",
"id": 1,
"subdomain": "string",
"roomType": "string",
"verified": false,
"name": "string",
"_group": "string"
},
"mentions": [
{
"postsCount": 1,
"avatarUrls": {
"small": "string",
"medium": "string",
"large": "string"
},
"id": "string",
"username": "string",
"verified": false,
"firstName": "string",
"lastName": "string",
"fullName": "string",
"memberType": 1,
"locations": {},
"followersCount": 1,
"displayName": "string"
}
],
"hasSourcePost": true,
"isSourcePostVisible": true,
"reReflectsCount": 1,
"isLiked": true,
"isByFollowedUser": true,
"isCommentedOn": true,
"isSaved": true,
"media": [
{}
],
"id": 1,
"authorId": "string",
"editSource": "string",
"privacySource": "string",
"body": "string",
"discussionId": 1,
"draft": false,
"createdAt": "2026-04-02T00:00:00.000Z",
"updatedAt": "2026-04-02T00:00:00.000Z",
"publishedAt": "2026-04-02T00:00:00.000Z",
"global": true,
"toxicityScore": 1,
"reported": false,
"views": 1,
"removed": false,
"verified": false,
"roomPostStatus": 0,
"hidden": false,
"commentsCount": 0,
"likesCount": 0,
"viewsCount": 0,
"readsCount": 0,
"languageId": 1,
"languageName": "string",
"moderationStatus": 1,
"reviewStatus": 1,
"reviewedAt": "2026-04-02T00:00:00.000Z",
"featuredAt": "2026-04-02T00:00:00.000Z",
"pushedUpAt": "2026-04-02T00:00:00.000Z",
"estimatedReadingTime": 0,
"roomId": 1,
"postTypeId": 1,
"postTypeName": "string",
"sourcePostId": 1
}
]
}
Source post not found