Get bookmark

Get a bookmark by details

Query Parameters

key integer required

Surah, Juz or page number.

mushaf 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

type string

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

Default value: ayah

The bookmark type.

verseNumber integer

The Ayah number of the bookmark

Responses

• 200
• 403
• 404
• 422
• 500

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object
id string required
createdAt date-time required
type string required
key integer required
verseNumber integer
group string

{
  "success": true,
  "data": {
    "id": "clq7ehtwt0005w4ox4t6q6hsp",
    "createdAt": "2023-01-21T07:28:13.023Z",
    "type": "ayah",
    "key": 1,
    "verseNumber": 5,
    "group": "string"
  }
}

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

GET /v1/bookmarks/bookmark

Authorization

name: o_t_htype: apiKeyin: header

Request

Base URL

https://auth.quran.com

ApiKeyAuth

key — query required

mushaf — query required

---123456711

type — query

---pagejuzsurahayah

verseNumber — query

curl / cURL

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

python / requests

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

go / native

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

php / cURL

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET 'https://auth.quran.com/v1/bookmarks/bookmark' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'