Users

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.

Manage profiles, following relationships, rooms, followers, and account actions.

📄️ Edit user profile

Partially update the authenticated user settings and preferences like notification settings, privacy options, and display preferences.

📄️ Get user profile

Retrieve the complete profile of the authenticated user including personal info, settings, statistics, and connected accounts.

📄️ Update user profile

Update user profile information including name, bio, username, avatar, and social links. Validates username uniqueness.

📄️ Get logged-in user rooms

Retrieve all rooms (groups and pages) the authenticated user is a member of. Supports filtering by name and pagination.

📄️ Search for users

Search users by name or username. Supports mentioning in posts, finding users for room invites, and general discovery. Results can be scoped to specific contexts.

📄️ Toggle follow/unfollow a user

Follow or unfollow another user. When following, their posts will appear in your FOLLOWING feed. Can optionally specify action to force follow/unfollow.

📄️ Remove a follower

Remove a user from your followers list. They will no longer see you as followed and won't receive notifications about your activity.

📄️ Get user profile by id or username

Retrieve a user profile by either UUID or username. If viewing your own profile, returns full data; otherwise returns public profile with follow relationship status.

📄️ Get user followers

Retrieve a paginated list of users who follow the specified user. Includes follow relationship to the viewer if authenticated.

📄️ Get users followed by user

Retrieve a paginated list of users that the specified user follows. Includes follow relationship to the viewer if authenticated.