Goals

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

• Use prelive.quran.com for auth-related testing.
• Use prelive.quranreflect.org for Quran Reflect paths where applicable.
• Do not mix production sessions or production user data with pre-live testing.

Create, update, delete, and estimate Quran reading goals.

📄️ Get today's goal plan

Get today's goal plan. When a goal exists, `goalId` is the reading goal id to use with update/delete goal endpoints, while `id` is the activity day id.

📄️ Update a goal

Update a goal

📄️ Delete a goal

Delete a goal by id.

📄️ Create a goal

Create a goal

📄️ Generate timeline estimation

Generate a timeline up to a week of the minimum daily amount required to meet the goal.