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

# Get group information from invitation link

> Retrieve group information without joining the group using its invitation link



## OpenAPI

````yaml /openapi.yml get /group/info-from-link
openapi: 3.0.0
info:
  title: WhatsApp API MultiDevice
  version: 9.7.0
  description: |
    This API is used for sending whatsapp via API.

    The web dashboard is a separate project (gowa-ui); the server downloads its
    latest release asset and serves it at `/` (or returns a JSON banner when
    APP_UI_ENABLED=false).

    Device scoping:
    - Send `X-Device-Id` on all device-scoped REST calls.
    - WebSocket: connect to `/ws?device_id=<id>`.
    - WebSocket auth (when basic auth is enabled): browsers cannot set an
      Authorization header on WebSocket connections, so also pass
      `&authorization=<base64(user:pass)>` in the query string. Use TLS in
      production since the credential is visible in the URL.
servers:
  - url: http://localhost:3000
security:
  - basicAuth: []
tags:
  - name: app
    description: Initial Connection to Whatsapp server
  - name: device
    description: Device management for multi-device support
  - name: user
    description: Getting information
  - name: send
    description: Send Message (Text/Image/File/Video).
  - name: message
    description: Message manipulation (revoke/react/update).
  - name: call
    description: Call management (reject incoming calls)
  - name: chat
    description: Chat conversations and messaging
  - name: group
    description: Group setting
  - name: newsletter
    description: newsletter setting
  - name: chatwoot
    description: Chatwoot integration for customer support
paths:
  /group/info-from-link:
    get:
      tags:
        - group
      summary: Get group information from invitation link
      description: >-
        Retrieve group information without joining the group using its
        invitation link
      operationId: getGroupInfoFromLink
      parameters:
        - $ref: '#/components/parameters/DeviceIdHeader'
        - name: link
          in: query
          required: true
          schema:
            type: string
          example: https://chat.whatsapp.com/whatsappKeyJoinGroup
          description: WhatsApp group invitation link
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupInfoFromLinkResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBadRequest'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInternalServer'
components:
  parameters:
    DeviceIdHeader:
      name: X-Device-Id
      in: header
      required: false
      description: >
        Device identifier for multi-device support. Required when multiple
        devices are registered.

        If only one device is registered, it will be used as the default.

        Can also be provided as `device_id` query parameter.
      schema:
        type: string
        example: my-device-id
  schemas:
    GroupInfoFromLinkResponse:
      type: object
      properties:
        code:
          type: string
          example: SUCCESS
        message:
          type: string
          example: Success get group info from link
        results:
          type: object
          properties:
            group_id:
              type: string
              example: 120363024512399999@g.us
              description: The group ID
            name:
              type: string
              example: Example Group Name
              description: The group name
            topic:
              type: string
              example: Welcome to our group! Please follow the rules.
              description: The group topic/description
            created_at:
              type: string
              format: date-time
              example: '2024-01-15T10:30:00Z'
              description: When the group was created
            participant_count:
              type: integer
              example: 25
              description: Number of participants in the group
            is_locked:
              type: boolean
              example: false
              description: Whether the group is locked (only admins can modify group info)
            is_announce:
              type: boolean
              example: false
              description: >-
                Whether the group is in announce mode (only admins can send
                messages)
            is_ephemeral:
              type: boolean
              example: false
              description: Whether the group has disappearing messages enabled
            description:
              type: string
              example: This group is for discussing project updates
              description: Additional description of the group
    ErrorBadRequest:
      type: object
      properties:
        code:
          type: string
          example: 400
          description: HTTP Status Code
        message:
          type: string
          example: field cannot be blank
          description: Detail error message
        results:
          type: object
          example: null
          description: additional data
    ErrorInternalServer:
      type: object
      properties:
        code:
          type: string
          example: INTERNAL_SERVER_ERROR
          description: SYSTEM_CODE_ERROR
        message:
          type: string
          example: you are not loggin
          description: Detail error message
        results:
          type: object
          example: null
          description: additional data
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````

## Related topics

- [Group Invite Link](https://gowa-docs.mintlify.site/api-reference/group/group-invite-link.md)
- [Join group with link](https://gowa-docs.mintlify.site/api-reference/group/join-group-with-link.md)
- [Group Info](https://gowa-docs.mintlify.site/api-reference/group/group-info.md)
- [Get list of participants in a group](https://gowa-docs.mintlify.site/api-reference/group/get-list-of-participants-in-a-group.md)
- [Get Business Profile Information](https://gowa-docs.mintlify.site/api-reference/user/get-business-profile-information.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.