> ## Documentation Index > Fetch the complete documentation index at: https://docs.liderhub.ai/llms.txt > Use this file to discover all available pages before exploring further. # Detalhe do grupo > Busca informações detalhadas do grupo. ## OpenAPI ````yaml /openapi/liderhub.json get /v1/groups/{group} openapi: 3.0.0 info: title: API Liderhub description: >- API REST para gerenciamento de conversas WhatsApp com IA. ## Autenticação A autenticação é obrigatória e deve ser feita utilizando o header `x-company-key`, gerado diretamente na plataforma Liderhub. Cada workspace possui uma chave própria, garantindo isolamento e segurança. ## Recursos disponíveis | Recurso | Descrição | |---------|-----------| | **Connections** | Gerenciar conexões WhatsApp do workspace | | **Contacts** | Listar, buscar, cadastrar contatos e marcar como lidos | | **Message** | Listar, buscar, enviar e cancelar mensagens agendadas | | **Agents** | Listar agentes de IA configurados | | **Users** | Listar usuários do workspace | | **Settings** | Consultar e atribuir status, origens, tags e departamentos aos chats | | **Groups** | Grupos WhatsApp: listar, detalhar, criar, atualizar nome/foto/configurações e gerenciar participantes e admins | | **Templates** | Listar, obter e enviar mensagens rápidas (templates) | ## Paginação Endpoints que retornam listas suportam paginação: - `page`: número da página (inicia em 1) - `limit`: itens por página (máximo 100) Retorno inclui metadados em `pagination`: page, limit, total, totalPages, hasNextPage, hasPreviousPage ## Filtros de lista (GET /v1/contacts) | Filtro | Tipo | Descrição | |--------|------|-----------| | `number` | string | Filtrar por número de telefone | | `connection` | UUID | Filtrar por conexão | | `id` | UUID | Filtrar por chat/contato — no máximo um resultado | | `department` | UUID | Filtrar por departamento | | `tags` | UUID | Filtrar por tag(s) - separar por vírgula | | `status` | UUID | Filtrar por status | | `stage` | enum | Filtrar por estágio: Open, Closed, Pending | | `hasUnread` | boolean | Filtrar contacts com mensagens não lidas | | `createdAfter` | ISO8601 | Criados após data | | `createdBefore` | ISO8601 | Criados antes de data | | `modifiedAfter` | ISO8601 | Modificados após data | | `modifiedBefore` | ISO8601 | Modificados antes de data | ⚠️ **Importante**: Utilize esta API de maneira responsável. Não forneça a credencial para terceiros. version: 1.0.0 contact: {} servers: - url: https://api.liderhub.com.br description: Produção security: [] tags: - name: Connections description: Gerenciar conexões WhatsApp do workspace - name: Contacts description: 'Contatos/conversas: listar e filtrar contatos.' - name: Message description: Listar, buscar, enviar e cancelar mensagens agendadas - name: Agents description: Listar agentes de IA configurados - name: Users description: Listar usuários do workspace - name: Settings description: Consultar e atribuir status, origens, tags e departamentos aos chats - name: Groups description: Gestão de grupos WhatsApp - name: Templates description: Templates / mensagens rápidas paths: /v1/groups/{group}: get: tags: - Groups summary: Detalhe do grupo description: Busca informações detalhadas do grupo. operationId: GroupController_getDetail parameters: - name: group required: true in: path description: >- UUID do chat de grupo (`Chat.id`; não é o mesmo recurso que `contact` em `/contacts`) schema: type: string responses: '200': description: Detalhe do grupo com participantes content: application/json: schema: $ref: '#/components/schemas/GroupDetailResponseDto' example: connection: aaaaaaaa-bbbb-cccc-dddd-111111111111 id: 75d7eece-e03c-4988-aafc-4621110187f1 name: Equipe Vendas title: Meta trimestral image: https://pps.whatsapp.net/v/t61.24694-24/… description: Canal oficial Participants: - AddRequest: null DisplayName: '' Error: 0 IsAdmin: false IsSuperAdmin: false LID: 22235196698849@lid PhoneNumber: '553288712823' last_update: '2026-04-16T12:00:00.000Z' '400': description: Chat não é grupo ou sem conexão/remoto JID válido '401': description: Não autorizado '404': description: Chat não encontrado '502': description: Falha ao consultar a instância WhatsApp security: - x-company-key: [] components: schemas: GroupDetailResponseDto: type: object properties: connection: type: string description: >- ID da conexão — o mesmo `id` retornado em GET /v1/connections (coluna `connectionNumber` do chat). format: uuid example: aaaaaaaa-bbbb-cccc-dddd-111111111111 id: type: string description: UUID do chat de grupo. Nas rotas use como `:group`. format: uuid example: 75d7eece-e03c-4988-aafc-4621110187f1 name: type: string description: Nome do grupo (Chat / WhatsApp) nullable: true example: Equipe Vendas title: type: string description: Tópico (coluna Topic), se existir nullable: true example: Meta trimestral image: type: string description: URL da foto do grupo nullable: true example: https://pps.whatsapp.net/v/… description: type: string description: Descrição do grupo nullable: true example: Canal oficial Participants: description: >- Participantes retornados pela instância (GET /group/info). Campos internos `JID` e `type` não são expostos. type: array items: $ref: '#/components/schemas/GroupParticipantDto' required: - connection - id - Participants GroupParticipantDto: type: object properties: AddRequest: type: object nullable: true description: Solicitação de entrada pendente, quando aplicável. example: null DisplayName: type: string description: Nome de exibição. example: '' Error: type: number description: Código de erro por participante (0 = sem erro na consulta) example: 0 IsAdmin: type: boolean description: Se é administrador do grupo example: false IsSuperAdmin: type: boolean description: Se é superadministrador example: false LID: type: string example: 22235196698849@lid description: LID (linked ID) PhoneNumber: type: string example: '553288712823' description: Número só com dígitos (sem sufixo @s.whatsapp.net). last_update: type: string example: '2026-04-16T12:00:00.000Z' description: Última atualização conhecida (string ISO). required: - DisplayName - Error - IsAdmin - IsSuperAdmin - LID - PhoneNumber securitySchemes: x-company-key: type: apiKey in: header name: x-company-key description: Chave de autenticação do workspace (gerada na plataforma Liderhub) ````