Skip to main content

Get user bookmarks‚Äč

Get all bookmarks. This includes bookmarks belonging to a collection.

Query Parameters
    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]

    The id of the Mushaf being used.

    1 = QCFV2

    2 = QCFV1

    3 = Indopak

    4 = UthmaniHafs

    5 = KFGQPCHAFS

    6 = Indopak15Lines

    7 = Indopak16Lines

    11 = Tajweeed

    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
    createdAt date-time required
    type string required
    key integer required
    verseNumber integer
    group string
  • ]
  • pagination object
    startCursor string
    endCursor string
    hasNextPage boolean
    hasPreviousPage boolean
Loading...