Get a post

Get a post.

Path Parameters

postId string required

The id of the post.

Responses

Request has been handled successfully.

application/json

Schema

Example (from schema)

Schema

success boolean

data object

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

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[]

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[]

tags object[]

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.

{
  "success": true,
  "data": {
    "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
  }
}

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

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ForbiddenError",
    "message": "Token expired"
  }
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "NotFoundError",
    "message": "The resource you're looking for does not exist"
  }
}

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

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ValidationError",
    "message": "`id` is required"
  }
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

Schema

success boolean

error object

{
  "success": false,
  "error": {
    "code": "ServerError",
    "message": "Something went wrong"
  }
}

GET /v1/posts/:postId

Authorization

name: o_t_htype: apiKeyin: header

Request

Base URL

https://auth.quran.com

ApiKeyAuth

postId — path required

curl / cURL
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

python / requests
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

go / native
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

nodejs / axios
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

ruby / Net::HTTP
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

csharp / RestSharp
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

php / cURL
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

java / OkHttp
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

powershell / RestMethod
curl -L -X GET 'https://auth.quran.com/v1/posts/:postId' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

Get a post​

Authorization

Request

Get a post