Goals

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.

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.