Rooms

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.

Manage Quran Reflect groups, pages, membership, invites, and room posts.

📄️ Update room admin access

Grant or revoke admin privileges for a user in a room. Only room owners or existing admins can modify admin access.

📄️ Update a group

Update group properties like name, description, URL, avatar, country, or public visibility. Only group admins/owners can update.

📄️ Create a new group

Create a new community group for sharing reflections. Groups can be public or private, and the creator becomes the owner.

📄️ Update a page

Update page properties like name, description, contact info, organization details, or visibility. Only page admins/owners can update.

📄️ Create a new page

Submit a request to create a new organizational page. Pages require admin approval and include organization details, contact info, and purpose statement.

📄️ Get room members

Retrieve paginated list of members in a room (group or page). Returns user profiles with their roles.

📄️ Invite user to room

Send an invitation to a user to join the room. User will receive a notification/email with an invite link. Only admins can invite.

📄️ Accept room invite

Accept an invitation to join a room using the token from the invite link. Adds user as member.

📄️ Reject room invite

Decline an invitation to join a room. Invalidates the invite token.

📄️ Remove member from room

Remove a user from a room (group or page). Only admins can remove other members. Users can remove themselves.

📄️ Get joined or managed rooms

Retrieve rooms the user has joined (joined-rooms) or manages as admin (managed-rooms). Supports search and pagination.

📄️ Search rooms

Search for public groups and pages by name or description. Results can be filtered by room type.

📄️ Get room profile by URL or subdomain

Retrieve a room profile by its unique URL (for groups) or subdomain (for pages). Returns room details, member counts, and relationship status.

📄️ Accept room invite by private token

Accept an invitation using a private room URL with embedded token. Alternative to the /accept-invite endpoint for direct link access.

📄️ Get room profile by ID

Retrieve a room profile by its unique numeric ID. Returns room details, member counts, and relationship status for the current user.

📄️ Get room posts

Retrieve paginated posts shared within a room. Supports filtering by tab (REFLECTIONS, DISCUSSIONS) and sorting (LATEST, POPULAR).

📄️ Join a group

Join a public group as a member. For private groups, an invitation is required. Returns whether the join was successful.

📄️ Leave a group

Leave a group the user is currently a member of. Owners cannot leave - they must transfer ownership first.

📄️ Follow a page

Follow an organizational page to see their posts in your feed. Pages represent verified organizations or scholars.

📄️ Unfollow a page

Stop following a page. Their posts will no longer appear in your personalized feed.

📄️ Update post privacy in room

Change the visibility of a post within a room. Toggle between public (visible outside room) and private (members only). Only admins can modify.