> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ezapi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Metadados por link de convite

> Consulta os metadados do grupo a partir de um link de convite.

Consulta os metadados do grupo a partir de um link de convite.

<Note>Aliases consolidados da collection: `Metadata do grupo por convite`.</Note>


## OpenAPI

````yaml GET /instances/{instanceId}/token/{instanceToken}/group-invitation-metadata
openapi: 3.0.3
info:
  title: EZ API
  version: 1.0.0
  description: >-
    Documentação pública reconstruída a partir da collection WA Gateway e
    validada contra os endpoints públicos existentes da EZ API.
servers:
  - url: https://api.ezapi.com.br
    description: Produção
  - url: http://localhost:3000
    description: Desenvolvimento local
security:
  - ClientToken: []
tags:
  - name: Instância
    description: >-
      Crie, conecte, monitore e ajuste o comportamento da sua instância do
      WhatsApp.
  - name: Mensagens
    description: >-
      Envie mensagens assíncronas em texto, mídia, interativos e recursos
      avançados.
  - name: Conversas
    description: Endpoints de conversas.
  - name: Contatos
    description: Endpoints de contatos.
  - name: Privacidade
    description: Endpoints de privacidade.
  - name: Grupos
    description: >-
      Crie grupos, gerencie participantes, convites, foto, descrição e
      permissões.
  - name: Status
    description: Endpoints de status.
  - name: Fila de mensagens
    description: Endpoints de fila de mensagens.
  - name: WhatsApp Business
    description: Endpoints de whatsapp business.
  - name: Webhooks
    description: Configure URLs HTTPS para receber eventos em tempo real da EZ API.
paths:
  /instances/{instanceId}/token/{instanceToken}/group-invitation-metadata:
    get:
      tags:
        - Grupos
      summary: Metadados por link de convite
      description: Consulta os metadados do grupo a partir de um link de convite.
      operationId: groups_invitation-metadata
      parameters:
        - name: instanceId
          in: path
          required: true
          description: Identificador único da instância.
          schema:
            type: string
            example: abc1234567890
        - name: instanceToken
          in: path
          required: true
          description: Token privado da instância retornado na criação.
          schema:
            type: string
            example: tok_a1b2c3d4e5f6
        - name: url
          in: query
          required: true
          description: URL do convite do grupo.
          schema:
            type: string
            example: https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA
      responses:
        '200':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  phone:
                    type: string
                    example: 120363123456789-group
                  owner:
                    type: string
                    example: '5511999999999'
                  subject:
                    type: string
                    example: Time EZ API
                  description:
                    type: string
                    example: Grupo operacional
                  creation:
                    type: integer
                    example: 1736200000
                  invitationLink:
                    type: string
                    example: https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA
                  contactsCount:
                    type: integer
                    example: 3
                  participantsCount:
                    type: integer
                    example: 3
                  participants:
                    type: array
                    items:
                      type: object
                      properties:
                        phone:
                          type: string
                          example: '5511999999999'
                        isAdmin:
                          type: boolean
                          example: true
                        isSuperAdmin:
                          type: boolean
                          example: true
                      required:
                        - phone
                        - isAdmin
                        - isSuperAdmin
                      example:
                        phone: '5511999999999'
                        isAdmin: true
                        isSuperAdmin: true
                    example:
                      - phone: '5511999999999'
                        isAdmin: true
                        isSuperAdmin: true
                  adminOnlyMessage:
                    type: boolean
                    example: false
                  adminOnlySettings:
                    type: boolean
                    example: false
                  requireAdminApproval:
                    type: boolean
                    example: false
                  isGroupAnnouncement:
                    type: boolean
                    example: false
                  subjectTime:
                    type: integer
                    example: 1736200000
                  subjectOwner:
                    type: string
                    example: '5511999999999'
                  communityId:
                    nullable: true
                required:
                  - phone
                  - owner
                  - subject
                  - description
                  - creation
                  - invitationLink
                  - contactsCount
                  - participantsCount
                  - participants
                  - adminOnlyMessage
                  - adminOnlySettings
                  - requireAdminApproval
                  - isGroupAnnouncement
                  - subjectTime
                  - subjectOwner
                  - communityId
                example:
                  phone: 120363123456789-group
                  owner: '5511999999999'
                  subject: Time EZ API
                  description: Grupo operacional
                  creation: 1736200000
                  invitationLink: https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA
                  contactsCount: 3
                  participantsCount: 3
                  participants:
                    - phone: '5511999999999'
                      isAdmin: true
                      isSuperAdmin: true
                  adminOnlyMessage: false
                  adminOnlySettings: false
                  requireAdminApproval: false
                  isGroupAnnouncement: false
                  subjectTime: 1736200000
                  subjectOwner: '5511999999999'
                  communityId: null
              example:
                phone: 120363123456789-group
                owner: '5511999999999'
                subject: Time EZ API
                description: Grupo operacional
                creation: 1736200000
                invitationLink: https://chat.whatsapp.com/D4HNtyc4TyDIXA7Y12T5JA
                contactsCount: 3
                participantsCount: 3
                participants:
                  - phone: '5511999999999'
                    isAdmin: true
                    isSuperAdmin: true
                adminOnlyMessage: false
                adminOnlySettings: false
                requireAdminApproval: false
                isGroupAnnouncement: false
                subjectTime: 1736200000
                subjectOwner: '5511999999999'
                communityId: null
        '401':
          description: Client-Token ou instanceToken inválido
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unauthorized
                message: Invalid instanceToken
        '404':
          description: Instância ou recurso não encontrado
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Instance not found
        '408':
          description: Timeout do worker
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Worker command timeout
        '422':
          description: Falha ao processar a ação
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unable to process request
      security:
        - ClientToken: []
components:
  securitySchemes:
    ClientToken:
      type: apiKey
      in: header
      name: Client-Token

````