Groups List API

The "get groups" API allows users to retrieve a list of groups and pages that they are a member of.

Query Parameters

client_auth_token string required

Client API token

Header Parameters

access-token string required

user access token

client string required

client access token

expiry string required
timestamp of token expiry
Example: 1531312879
token-type string required
access token type
Example: Bearer
uid string required
usr uid
Example: user@quranreflect.com

Responses

• 200
• 401

---

List of rooms/groups

application/json

Schema

Example (from schema)

---

Schema

success boolean

Default value: true

pages object required
List ofrooms that the user can access
rooms object[]
Array [
id string
The Id of the room
]
groups object
List of groups that the user can access
rooms object[]
Array [
id string
The Id of the room
]

{
  "success": true,
  "groups": {
    "rooms": [
      {
        "id": "string"
      }
    ]
  }
}

Unauthorized response, api will respond with this 401 eithr user is not logged in or do not have permission to perform some action. Like creating a post in a room, but user is not member of room.

System will also return 401 if api token is missing or invlaid.

application/json

Schema

Example (from schema)

not logged in

missing or invalid api key

---

Schema

errors string[]
status integer

Default value: 401

success boolean

Default value: false

{
  "errors": [
    "string"
  ],
  "status": 401,
  "success": false
}

{
  "errors": [
    "You need to sign in or sign up before continuing."
  ],
  "success": false
}

{
  "message": "You don't have permission!",
  "status": 401,
  "success": false
}

Loading...