Skip to main content

Get bookmark collections

Get all collections that a bookmark belongs to by bookmark details.

Query Parameters
    key float required

    Surah, Juz or page number.

    type string

    Possible values: [page, juz, surah, ayah]

    Default value: ayah

    The bookmark type.

    mushafId integer required

    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

    last integer

    Possible values: >= 1 and <= 20

    The number of items to be fetched. Should be used together with before

    first object

    Possible values: >= 1 and <= 20

    The number of items to be fetched.

    after object

    The cursor after which you want to get the next page of items. Should be used together with first

    before object

    The cursor before which the previous page of items will be fetched. Should be used together with last

Responses

Request has been handled successfully.


Schema
    success boolean
    data object[]
  • Array [
  • id string required
    updatedAt date-time required
    name string required
  • ]
GET /v1/bookmarks/collections

Authorization

name: x-auth-tokentype: apiKeyin: headerdescription: The JWT access token required for accessing the endpoints.
name: x-client-idtype: apiKeyin: headerdescription: Your client id

Request

Base URL
https://apis-prelive.quran.foundation/auth
x-auth-token
x-client-id
key — query required
mushafId — query required
type — query
last — query
first — query
after — query
before — query
curl / cURL
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/bookmarks/collections' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'