Get user groups

Get all groups

Responses

• 200
• 400
• 401
• 403
• 404
• 422
• 429
• 500
• 502
• 503
• 504

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object
pages object[]
List of user pages.
Array [
id integer required
The id of the room.
name string required
The name of the room.
description string required
The description of the room.
public boolean required
Whether the group is public or not.
active boolean required
Whether the group is active or not.
verified boolean required
Whether the group is verified or not. Will be true if it's a page.
subdomain string required
The subdomain of the page. Will be empty when it is a group.
roomType string required
Possible values: [page, group]
The type of the group
group string required
The group slug. Will be empty when it is a page.
avatar string required
The avatar of the group.
link string required
The link of the group/page. Will contain only the base domain when it is a page.
membersCount integer required
The number of members.
postsCount integer required
The number of posts.
currentUserIsAdmin boolean required
Whether the current user is an admin or not.
]
groups object[]
List of user groups.
Array [
id integer required
The id of the room.
name string required
The name of the room.
description string required
The description of the room.
public boolean required
Whether the group is public or not.
active boolean required
Whether the group is active or not.
verified boolean required
Whether the group is verified or not. Will be true if it's a page.
subdomain string required
The subdomain of the page. Will be empty when it is a group.
roomType string required
Possible values: [page, group]
The type of the group
group string required
The group slug. Will be empty when it is a page.
avatar string required
The avatar of the group.
link string required
The link of the group/page. Will contain only the base domain when it is a page.
membersCount integer required
The number of members.
postsCount integer required
The number of posts.
currentUserIsAdmin boolean required
Whether the current user is an admin or not.
]

{
  "success": true,
  "data": {
    "pages": [
      {
        "id": 123,
        "name": "My Halaqa",
        "description": "This is our Halaqa's group.",
        "public": false,
        "active": true,
        "verified": true,
        "subdomain": "my-page",
        "roomType": "page",
        "group": "my-halaqa",
        "avatar": "/avatars/original/missing.png",
        "link": "https://quranreflect.com/groups/my-room123",
        "membersCount": 5,
        "postsCount": "",
        "currentUserIsAdmin": true
      }
    ],
    "groups": [
      {
        "id": 123,
        "name": "My Halaqa",
        "description": "This is our Halaqa's group.",
        "public": false,
        "active": true,
        "verified": true,
        "subdomain": "my-page",
        "roomType": "page",
        "group": "my-halaqa",
        "avatar": "/avatars/original/missing.png",
        "link": "https://quranreflect.com/groups/my-room123",
        "membersCount": 5,
        "postsCount": "",
        "currentUserIsAdmin": true
      }
    ]
  }
}

The request is missing required parameters or is invalid.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

The request is unauthorized.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Too many requests, please try again later.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Invalid response from the upstream server

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

The server did not receive a timely response from the upstream server.

application/json

Schema

Example (from schema)

---

Schema

message string
type string
success boolean

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

GET /v1/groups/

Authorization

name: x-auth-tokentype: apiKeyin: headerdescription: The JWT access token required for accessing the endpoints.

name: x-client-idtype: apiKeyin: headerdescription: Your client id

Request

Base URL

https://apis-prelive.quran.foundation/auth

x-auth-token

x-client-id

curl / cURL

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

python / requests

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

go / native

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

nodejs / axios

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

csharp / RestSharp

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

php / cURL

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET 'https://apis-prelive.quran.foundation/auth/v1/groups/' \
-H 'Accept: application/json' \
-H 'x-auth-token: <API_KEY_VALUE>' \
-H 'x-client-id: <API_KEY_VALUE>'