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, 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

• 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": "cm1ll55xw00051dq71n7h36sc",
      "createdAt": "2023-01-21T07:28:13.023Z",
      "type": "ayah",
      "key": 1,
      "verseNumber": 5,
      "group": "string"
    }
  ],
  "pagination": {
    "startCursor": "cm1ll55l800021dq7epqpcylm",
    "endCursor": "cm1ll55l800031dq791nvarqa",
    "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...