GET
/
groups
curl --request GET \
  --url https://api.zapperapi.com/{instanceId}/groups \
  --header 'X-Api-Key: <api-key>'
{
  "groups": [
    {
      "id": "<string>",
      "owner": "<string>",
      "subject": "<string>",
      "subjectOwner": "<string>",
      "subjectTime": 123,
      "creation": 123,
      "desc": "<string>",
      "descOwner": "<string>",
      "descId": "<string>",
      "linkedParent": "<string>",
      "restrict": true,
      "announce": true,
      "memberAddMode": true,
      "joinApprovalMode": true,
      "isCommunity": true,
      "isCommunityAnnounce": true,
      "size": 123,
      "participants": [
        {
          "id": "<string>",
          "isAdmin": true,
          "isSuperAdmin": true,
          "admin": "admin"
        }
      ],
      "ephemeralDuration": 123,
      "inviteCode": "<string>",
      "author": "<string>"
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

Chave privada da API

Query Parameters

​
showParticipants
string
default:false

Indica se deseja mostrar os participantes dos grupos

Response

200 - application/json
Default Response
​
groups
object[]
required