Get today's goal plan
Get today's goal plan.
Query Parameters
type string required
Possible values: [QURAN_TIME, QURAN_PAGES, QURAN_RANGE, COURSE, QURAN_READING_PROGRAM]
The type of the goal.
Header Parameters
x-timezone string
The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 500
- 502
- 503
- 504
Request has been handled successfully.
application/json
Schema
Example (from schema)
Schema
success boolean
data object
{
"success": true,
"data": {
"id": "cm8qg6sr70004agpscqo23tc2",
"date": "2023-09-31",
"progress": 0.695,
"type": "QURAN",
"ranges": [
"1:1-1:2"
],
"pagesRead": 0,
"secondsRead": 0,
"versesRead": 0,
"manuallyAddedSeconds": 0,
"dailyTargetPages": 0,
"dailyTargetSeconds": 0,
"dailyTargetRanges": [
"1:1-1:2"
],
"remainingDailyTargetRanges": [
"1:1-1:2"
],
"mushafId": 4
}
}
The request is missing required parameters or is invalid.
application/json
Schema
Example (from schema)
Schema
message string
type string
success boolean
{
"message": "The request is missing required headers or is invalid",
"type": "invalid_request",
"success": false
}
The request is unauthorized.
application/json
Schema
Example (from schema)
Schema
message string
type string
success boolean
{
"message": "The request requires user authentication",
"type": "unauthorized",
"success": 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
message string
type string
success boolean
{
"message": "The server understood the request, but refuses to authorize it",
"type": "forbidden",
"success": false
}
Not Found. The resource being accessed does not exist.
application/json
Schema
Example (from schema)
Schema
message string
type string
success boolean
{
"message": "The requested resource could not be found",
"type": "not_found",
"success": false
}
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
message string
type string
success boolean
{
"message": "The request was well-formed but was unable to be followed due to semantic errors",
"type": "unprocessable_entity",
"success": false
}
Too many requests, please try again later.
application/json
Schema
Example (from schema)
Schema
message string
type string
success boolean
{
"message": "Too many requests, please try again later",
"type": "rate_limit_exceeded",
"success": false
}
Server Error. Something went wrong, try again later.
application/json
Schema
Example (from schema)
Schema
message string
type string
success boolean
{
"message": "The server encountered an internal error and was unable to complete your request",
"type": "internal_server_error",
"success": false
}
Invalid response from the upstream server
application/json
Schema
Example (from schema)
Schema
message string
type string
success boolean
{
"message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
"type": "bad_gateway",
"success": false
}
The server is currently unable to handle the request due to a temporary overload or scheduled maintenance
application/json
Schema
Example (from schema)
Schema
message string
type string
success boolean
{
"message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
"type": "service_unavailable",
"success": false
}
The server did not receive a timely response from the upstream server.
application/json
Schema
Example (from schema)
Schema
message string
type string
success boolean
{
"message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
"type": "gateway_timeout",
"success": false
}
GET /v1/goals/get-todays-plan
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
Request
curl / cURL
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
python / requests
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
go / native
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
nodejs / axios
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
ruby / Net::HTTP
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
csharp / RestSharp
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
php / cURL
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
java / OkHttp
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'
powershell / RestMethod
curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/goals/get-todays-plan' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'