Get bookmark
Get a bookmark by details
Query Parameters
Surah, Juz or page number.
Possible values: [page, juz, surah, ayah]
Default value: ayah
The bookmark type.
The Ayah number of the bookmark
Possible values: [1, 2, 3, 4, 5, 6, 7, 11, 19]
The id of the Mushaf being used.
1 = QCFV2
2 = QCFV1
3 = Indopak
4 = UthmaniHafs
5 = KFGQPCHAFS
6 = Indopak15Lines
7 = Indopak16Lines
11 = Tajweeed
19 = QCFTajweedV4
- 200
- 403
- 404
- 422
- 500
Request has been handled successfully.
Schema
data object
{
"success": true,
"data": {
"id": "cm3k2dqyl00050jpzgyr9bt9h",
"createdAt": "2023-01-21T07:28:13.023Z",
"type": "ayah",
"key": 1,
"verseNumber": 5,
"group": "string"
}
}
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.
Schema
error object
{
"success": false,
"error": {
"code": "ForbiddenError",
"message": "Token expired"
}
}
Not Found. The resource being accessed does not exist.
Schema
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.
Schema
error object
{
"success": false,
"error": {
"code": "ValidationError",
"message": "`id` is required"
}
}
Server Error. Something went wrong, try again later.
Schema
error object
{
"success": false,
"error": {
"code": "ServerError",
"message": "Something went wrong"
}
}