Skip to main content
GET
Listar todos os grupos

Autorizações

apikey
string
header
obrigatório

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Resposta

Sucesso — corpo de resposta nativo do provedor.

id
string

Group JID.

subject
string

Group name/subject.

subjectOwner
string

JID of the participant who last set the subject.

subjectTime
integer

Unix timestamp (seconds) when the subject was last set.

pictureUrl
string | null

URL of the group profile picture, or null if none.

size
integer

Number of participants.

creation
integer

Unix timestamp (seconds) when the group was created.

owner
string

JID of the group owner/creator.

desc
string

Group description text.

descId
string

Identifier of the current description.

restrict
boolean

If true, only admins can edit group info.

announce
boolean

If true, only admins can send messages (announcement group).

isCommunity
boolean

Whether this group is a community parent.

isCommunityAnnounce
boolean

Whether this is a community announcement group.

linkedParent
string | null

JID of the linked community parent, when applicable.

participants
object[]

Group participants (only present when getParticipants=true).