Get bookmarks within a range of Ayahs
Get all bookmarks within a specific Ayahs range.
Query Parameters
The number of the Surah that the Ayahs range belong to.
The Ayah number at which the range starts.
The Ayah number at which the range ends.
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 11
]
The id of the Mushaf being used.
1 = QCFV2
2 = QCFV1
3 = Indopak
4 = UthmaniHafs
5 = KFGQPCHAFS
6 = Indopak15Lines
7 = Indopak16Lines
11 = Tajweeed
- 200
- 403
- 404
- 422
- 500
Request has been handled successfully.
Schema
- Array [
- ]
data object[]
pagination object
{
"success": true,
"data": [
{
"id": "clz897g35000514qeerknd27q",
"createdAt": "2023-01-21T07:28:13.023Z",
"type": "ayah",
"key": 1,
"verseNumber": 5,
"group": "string"
}
],
"pagination": {
"startCursor": "clz897fpl000214qe6qyuec8g",
"endCursor": "clz897fpl000314qe1s9he2n0",
"hasNextPage": true,
"hasPreviousPage": 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.
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"
}
}