Get Group Information
- Print
- DarkLight
- PDF
Get Group Information
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/groups.info
Retrieves the information about a private group you belong to.
Changelog
| Version | Description |
|---|---|
| 0.48.0 | Added |
Header parameters
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Query parameters
roomId
string
The room id. It is required if the roomName is not provided.
Exampledlpfuijw7ej
roomName
string
The room name. It is required if the roomId is not provided.
Examplegeneral
Responses
200
OK
Success
{
"group": {
"_id": "ByehQjC44FwMeiLbX",
"name": "testing",
"fname": "testing",
"t": "p",
"msgs": 0,
"usersCount": 2,
"u": {
"_id": "HKKPmF8rZh45GMHWH",
"username": "marc.anp"
},
"customFields": {},
"broadcast": false,
"encrypted": false,
"ts": "2020-05-21T13:16:24.749Z",
"ro": false,
"default": false,
"sysMes": true,
"_updatedAt": "2020-05-21T13:16:24.772Z"
},
"success": true
}object
group
object
_id
string
name
string
fname
string
t
string
msgs
integer
usersCount
integer
u
object
_id
string
username
string
customFields
object
broadcast
boolean
encrypted
boolean
ts
string
ro
boolean
default
boolean
sysMes
boolean
_updatedAt
string
success
boolean
Was this article helpful?