Get posts

Get list of posts.

Query Parameters

exactAyah boolean

Get posts of an exact Ayah only and not of range of Ayahs (the default behavior).

languages string

Comma-separated language iso codes, to fetch posts in a specific language(s).

scholarsPosts boolean

Include posts of scholars

authorIds integer[]

The Ids of the authors of the posts

studentsOfKnowledgePosts boolean

Include posts of students of knowledge

verified boolean

Include verified posts

approved boolean

Include approved posts

updatedSince string

Get posts that are updated after the given date (inclusive).

filters object

Further customize the results, you can fetch posts of specific members, post that have specific tags, post for specific surah, ayah range or single ayah etc.

tab string

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

Default value: most_popular

newest = Recent posts will be at the top.

following = Get posts of authors the current user is following.

draft = Get current user's private posts.

favorite = Get current user's favorite posts.

most_popular = Get most popular posts.

only_room_members = Get posts that are posted by current room members.

public = Include public posts of private rooms.

feed = When passed, this will ignore most passed filters and send verified posts (if verified = true), posts by scholars and student of knowledge, verified posts, posts from author the user is following.

feed boolean

Include only trusted posts and posts by author the user is following.

page integer

The current post page. Each page will have 25 posts by default. pages response field will have the total number of pages.

Responses

• 200
• 400
• 401
• 403
• 404
• 422
• 429
• 500
• 502
• 503
• 504

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object

posts object[]

List of posts

Array [

id integer required

The ID of the post.

body string required

The body of the post.

likes integer required

The number of likes.

isPrivate boolean required

Default value: false

Whether the post should be publicly viewed or not.

publishedAt string required

The date the post was published at. Format of the date is MMMM dd, yyyy HH:mm

createdAt string required

The date the post was created at. Format of the date is MMMM dd, yyyy HH:mm

lastUpdated string required

The date the post was last updated. Format of the date is MMMM dd, yyyy HH:mm

author object

Details about the author.

id integer required

The id of the author of the comment.

username string required

The username of the author of the comment.

firstName string required

The first name of the author of the comment.

lastName string required

The first name of the author of the comment.

displayName string required

The display name of the author of the comment.

verified boolean required

Whether the comment's author has been verified.

profileImage string nullable required

The profile image of the author of the comment. Will be null if it's empty

followed boolean required

Whether the current user is following the author of the comment or not.

language string required

The language of the post.

liked boolean required

Default value: false

Whether the post was liked by the current user or not.

saved boolean required

Default value: false

Whether the post was saved by the current user or not.

verified boolean required

Default value: false

Whether the post is verified or not.

hidden boolean required

Default value: false

Whether the post is hidden or not.

views integer required

The number of views.

global boolean required

Default value: false

Whether the post is global or not. A post inside a room can be set to global and becomes visible to everyone.

editable boolean required

Default value: false

Whether the post is editable or not. It will be true if the post belongs to the current user.

deletable boolean required

Default value: false

Whether the post is deletable or not. It will be true if the post belongs to the current user.

reportable boolean required

Default value: false

Whether the current user can report the post or not.

restorable boolean required

Default value: false

Whether the current user can restore the post after it was deleted or not.

comments object[]

List of comments that belong to the post.

Array [

id integer required

The id of the comment.

createdAt string required

The creation date of the comment.

hidden boolean required

Whether the comment is hidden.

body string required

The body of the comment.

parentId integer nullable required

The parent comment's id. Will be null if this comment does not have a parent.

author object

Details about the author.

id integer required

The id of the author of the comment.

username string required

The username of the author of the comment.

firstName string required

The first name of the author of the comment.

lastName string required

The first name of the author of the comment.

displayName string required

The display name of the author of the comment.

verified boolean required

Whether the comment's author has been verified.

profileImage string nullable required

The profile image of the author of the comment. Will be null if it's empty

followed boolean required

Whether the current user is following the author of the comment or not.

]

commentsCount integer required

The number of comments the post has. This includes private comments.

publicCommentsCount integer required

The number of public comments the post has.

roomId integer nullable required

The Id of the room the post belongs to.

group string nullable required

The name of the group the post belongs to. Will be null it the post does not belong to a group.

groupLink string nullable required

The link to the group the post belongs to. Will be null it the post does not belong to a group.

postTitle string required

A social-media sharable title of the post.

references object[]

Array [

surahId integer required

Possible values: >= 1 and <= 114

The Surah number

fromAyah integer nullable

Possible values: >= 1 and <= 286

The start of the range of Ayah(s) in a Surah that the post relates to.

If it's a single Ayah,fromAyah and toAyah should have the same value.

If the post belongs to the entire Surah, fromAyah and toAyah should be left empty

toAyah integer nullable

Possible values: >= 1 and <= 286

The end of the range of Ayah(s) in a Surah that the post relates to.

If it's a single Ayah,fromAyah and toAyah should have the same value.

If the post belongs to the entire Surah, fromAyah and toAyah should be left empty

isSurah boolean

Default value: false

Whether the post belongs to the entire Surah.

]

tags object[]

List of tags the post belongs to. If tags not passed with update post API, existing references of the post will be removed.

Array [

id integer required

The Id of the tag

name string required

The name of the tag.

language string required

The language of the tag.

]

roomPostStatus RoomPostStatus required

Possible values: [as_room, publicly, only_members]

The room post status.

estimatedReadingTime float required

The average number of milliseconds it takes to read the post. It can be 0 if the value could not be estimated.

]

pages integer

Number of pages matching the queried posts

{
  "success": true,
  "data": {
    "posts": [
      {
        "id": 123,
        "body": "This is a reflection example!",
        "likes": 5,
        "isPrivate": false,
        "publishedAt": "March 03, 2023 05:45",
        "createdAt": "March 03, 2023 05:45",
        "lastUpdated": "March 03, 2023 05:45",
        "author": {
          "id": 135,
          "username": "amer",
          "firstName": "Amer",
          "lastName": "Abbas",
          "displayName": "A Abbas",
          "verified": true,
          "profileImage": "//s3.amazonaws.com/qreflect-bucket/events/banner/en/avatars/15514/medium.png?1655384045",
          "followed": true
        },
        "language": "ENGLISH",
        "liked": false,
        "saved": false,
        "verified": false,
        "hidden": false,
        "views": 5,
        "global": false,
        "editable": false,
        "deletable": false,
        "reportable": false,
        "restorable": false,
        "comments": [
          {
            "id": 135,
            "createdAt": "2018-06-27T14:49:10.000Z",
            "hidden": false,
            "body": "Ma shaa Allah Lahawla walaquwata illa billah",
            "parentId": 135,
            "author": {
              "id": 135,
              "username": "amer",
              "firstName": "Amer",
              "lastName": "Abbas",
              "displayName": "A Abbas",
              "verified": true,
              "profileImage": "//s3.amazonaws.com/qreflect-bucket/events/banner/en/avatars/15514/medium.png?1655384045",
              "followed": true
            }
          }
        ],
        "commentsCount": 5,
        "publicCommentsCount": 5,
        "roomId": 123,
        "group": "Muslim American Society",
        "groupLink": "Muslim American Society",
        "postTitle": "Osama Sayed's Reflection on Surah Al-Aadiyaat:8",
        "references": [
          {
            "surahId": 2
          },
          {
            "surahId": 5,
            "fromAyah": 6,
            "toAyah": 8
          },
          {
            "surahId": 114,
            "fromAyah": 2,
            "toAyah": 2
          }
        ],
        "tags": [
          {
            "id": 1698,
            "name": "PodTafseer",
            "language": "ENGLISH"
          }
        ],
        "roomPostStatus": "as_room",
        "estimatedReadingTime": 55018.9
      }
    ],
    "pages": 0
  }
}

The request is missing required parameters or is invalid.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

The request is unauthorized.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Too many requests, please try again later.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Invalid response from the upstream server

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

The server did not receive a timely response from the upstream server.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

GET /v1/posts/

Authorization

name: x-auth-tokentype: apiKeyin: headerdescription: The JWT access token required for accessing the endpoints.

name: x-client-idtype: apiKeyin: headerdescription: Your client id

Request

Base URL

https://apis-prelive.quran.foundation/auth

x-auth-token

x-client-id

exactAyah — query

---truefalse

languages — query

scholarsPosts — query

---truefalse

authorIds — query

studentsOfKnowledgePosts — query

---truefalse

verified — query

---truefalse

approved — query

---truefalse

updatedSince — query

filters — query

tab — query

---newestfollowingdraftfavoritemost_popularonly_room_memberspublicfeed

feed — query

---truefalse

page — query

curl / cURL

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

python / requests

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

go / native

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

php / cURL

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/posts/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'