Get bookmarks within a range of Ayahs

Get all bookmarks within a specific Ayahs range.

Query Parameters

mushafId integer required

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

chapterNumber integer required

The number of the Surah that the Ayahs range belong to.

rangeStartAyahNumber integer required

The Ayah number at which the range starts.

rangeEndAyahNumber integer required

The Ayah number at which the range ends.

Responses

• 200
• 403
• 404
• 422
• 500

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object[]
Array [
id string required
createdAt date-time required
type string required
key integer required
verseNumber integer
group string
]
pagination object
startCursor string
endCursor string
hasNextPage boolean
hasPreviousPage boolean

{
  "success": true,
  "data": [
    {
      "id": "cltzxhmy50005z5qf0h9t14io",
      "createdAt": "2023-01-21T07:28:13.023Z",
      "type": "ayah",
      "key": 1,
      "verseNumber": 5,
      "group": "string"
    }
  ],
  "pagination": {
    "startCursor": "cltzxhmnt0002z5qffkc5gmg7",
    "endCursor": "cltzxhmnt0003z5qf9xek8g6r",
    "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.

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"
  }
}

Loading...