Pular para o conteúdo principal
POST
/
group
/
list
Listar todos os grupos com filtros e paginacao
curl --request POST \
  --url https://api.zappfy.io/group/list \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "page": 1,
  "pageSize": 50,
  "limit": 123,
  "offset": 0,
  "search": "<string>",
  "force": false,
  "noParticipants": false
}
'
{
  "groups": [
    {
      "JID": "[email protected]",
      "OwnerJID": "[email protected]",
      "Name": "Grupo de Suporte",
      "NameSetAt": "2023-11-07T05:31:56Z",
      "NameSetBy": "<string>",
      "Topic": "<string>",
      "IsLocked": true,
      "IsAnnounce": true,
      "AnnounceVersionID": "<string>",
      "IsEphemeral": true,
      "DisappearingTimer": 1,
      "IsIncognito": true,
      "IsParent": true,
      "IsJoinApprovalRequired": true,
      "LinkedParentJID": "<string>",
      "IsDefaultSubGroup": true,
      "GroupCreated": "2023-11-07T05:31:56Z",
      "ParticipantVersionID": "<string>",
      "Participants": [
        "<unknown>"
      ],
      "MemberAddMode": "admin_add",
      "OwnerCanSendMessage": true,
      "OwnerIsAdmin": true,
      "DefaultSubGroupId": "<string>",
      "invite_link": "<string>",
      "request_participants": "<string>"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "pageSize": 123,
    "currentPage": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Authorizations

token
string
header
required

Body

application/json
page
integer
default:1

Numero da pagina para paginacao (padrao 1)

pageSize
integer
default:50

Quantidade de resultados por pagina (padrao 50, maximo 1000)

limit
integer

Alias opcional para pageSize

offset
integer
default:0

Deslocamento base zero; se informado recalcula a pagina

Texto para filtrar grupos por nome/JID

force
boolean
default:false

Se definido como true, forca a atualizacao do cache de grupos. Util para garantir que as informacoes mais recentes sejam recuperadas.

noParticipants
boolean
default:false

Se definido como true, retorna a lista de grupos sem incluir os participantes. Util para otimizar a resposta quando nao ha necessidade dos dados dos participantes.

Response

Lista de grupos recuperada com sucesso

groups
object[]

Lista detalhada de grupos

pagination
object