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.

Get logged-in user rooms

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

Query Parameters

name string

Filter rooms by name

page number

Page number (default: 1)

limit number

Rooms per page (default: 10)

Responses

• 200
• 401

---

User rooms with pagination metadata

application/json

Schema

Example (from schema)

Example

---

Schema

total number required
currentPage number required
limit number required
pages number required
data object[] required
Array [
id number required
name string required
group string required
public boolean required
roomType string required
verified boolean required
subdomain string required
description string required
membersCount number required
avatarUrl object required
small string
medium string
large string
]

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": 0,
      "name": "string",
      "group": "string",
      "public": true,
      "roomType": "string",
      "verified": true,
      "subdomain": "string",
      "description": "string",
      "membersCount": 0,
      "avatarUrl": {
        "small": "string",
        "medium": "string",
        "large": "string"
      }
    }
  ]
}

{
  "total": 10,
  "currentPage": 1,
  "limit": 10,
  "pages": 1,
  "data": [
    {
      "id": 1,
      "name": "string",
      "group": "string",
      "public": true,
      "roomType": "string",
      "verified": true,
      "subdomain": "string",
      "description": "string",
      "membersCount": 1,
      "avatarUrl": {
        "small": "string",
        "medium": "string",
        "large": "string"
      }
    }
  ]
}

User not authenticated

Loading...