Get user groups

Get all groups

Responses

• 200
• 403
• 404
• 422
• 500

---

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
      }
    ]
  }
}

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

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ForbiddenError",
    "message": "Token expired"
  }
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "NotFoundError",
    "message": "The resource you're looking for does not exist"
  }
}

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

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ValidationError",
    "message": "`id` is required"
  }
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ServerError",
    "message": "Something went wrong"
  }
}

Loading...