Get user notifications

Get user notifications.

Responses

• 200
• 403
• 404
• 422
• 500

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object
notifications object[]
Array [
id integer required
The notification Id.
body string required
The notification body. Might contain HTML.
avatarUrl string required
The Avatar url of the user the notification is related to.
createdAt string required
The creation date of the notification.
postUrl string required
The post URL the notification is related to.
]

{
  "success": true,
  "data": {
    "notifications": [
      {
        "id": 6446043,
        "body": "<span class='colored'>Mohammad Elshinawy</span> added a new reflection.",
        "avatarUrl": "//s3.amazonaws.com/qreflect-bucket/events/banner/en/avatars/80/medium.png?1590842297",
        "createdAt": "2023-02-18T16:43:19.000Z",
        "postUrl": "https://quranreflect.com/posts/17052"
      }
    ]
  }
}

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
code string
message string

{
  "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
code string
message string

{
  "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
code string
message string

{
  "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
code string
message string

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

GET /v1/users/notifications

Authorization

name: o_t_htype: apiKeyin: header

Request

Base URL

https://auth.quran.com

ApiKeyAuth

curl / cURL

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

python / requests

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

go / native

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

nodejs / axios

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

ruby / Net::HTTP

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

csharp / RestSharp

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

php / cURL

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

java / OkHttp

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

powershell / RestMethod

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