Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Get reading bookmark slots​

Get the user's materialized reading bookmark slots ordered by slot. Cleared slots are returned as tombstones; slots that have never been created are omitted.

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

Responses

Request has been handled successfully.


Schema
    success boolean
    data object[]
  • Array [
  • id string required
    slot integer required

    Possible values: >= 1 and <= 3

    One-based reading bookmark slot. Valid values are 1, 2, and 3.

    name string nullable required

    Optional custom name. Null uses the localized default name.

    mushafId integer nullable required
    type string nullable required

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

    group string nullable required
    key integer nullable required
    verseNumber integer nullable required
    metadata object nullable required
    createdAt date-time required
    updatedAt date-time required
    clientCreatedAt date-time nullable required

    Server-maintained creation timestamp; legacy rows may be null.

    clientUpdatedAt date-time nullable required

    Server-maintained last effective change timestamp; request values are ignored.

  • ]
Loading...