Search Group Information

GET 
/api/v2/instance/:instanceId/group/:groupJid

Search Group Information

Request

Path Parameters

instanceId stringrequired

ID of the instance.

groupJid stringrequired

The unique identifier of the group for which you want to fetch information.

Responses

201

GroupCreateResponse

application/json

Schema

Schema

id stringrequired
owner stringrequired
subject stringrequired
subjectOwner string
subjectTime number
creation string
leave number
desc string
descOwner string
descId string
restrict boolean
announce boolean
size number
participants object[]required
Array [
id stringrequired
name string
notify string
verifiedName string
imgUrl string
status string
isAdmin boolean
isSuperAdmin boolean
admin string
Default value: admin | superadmin
]
ephemeralDuration number
inviteCode string

Example (from schema)

{
  "id": "string",
  "owner": "string",
  "subject": "string",
  "subjectOwner": "string",
  "subjectTime": 0,
  "creation": "string",
  "leave": 0,
  "desc": "string",
  "descOwner": "string",
  "descId": "string",
  "restrict": true,
  "announce": true,
  "size": 0,
  "participants": [
    {
      "id": "string",
      "name": "string",
      "notify": "string",
      "verifiedName": "string",
      "imgUrl": "string",
      "status": "string",
      "isAdmin": true,
      "isSuperAdmin": true,
      "admin": "admin | superadmin"
    }
  ],
  "ephemeralDuration": 0,
  "inviteCode": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

404

NotFoundException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...