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

# Get invite code

> Returns the current invite code/link for a group. Pass the group JID as the `groupJid` query parameter.



## OpenAPI

````yaml openapi.evolution-v2.json GET /group/inviteCode/{instance}
openapi: 3.1.0
info:
  title: Evolution V2 Layer
  version: 1.0.0
  description: >-
    Pilot Status API Layer — Evolution V2. Base URL
    `https://pilotstatus.com.br/api/layer/evolution-v2`. Authenticate with the
    `apikey` header (your Pilot Status `ps_` key). Instance/session endpoints
    are NOT available through the layer.
servers:
  - url: https://pilotstatus.com.br/api/layer/evolution-v2
security:
  - apiKey: []
tags:
  - name: Call & Business
  - name: Chat
  - name: Group
  - name: Label
  - name: Message
  - name: Profile
  - name: Settings & Proxy
  - name: Storage (S3)
  - name: Template
paths:
  /group/inviteCode/{instance}:
    get:
      tags:
        - Group
      summary: Get invite code
      description: >-
        Returns the current invite code/link for a group. Pass the group JID as
        the `groupJid` query parameter.
      operationId: get__group_inviteCode_instance
      parameters:
        - name: instance
          in: path
          required: true
          schema:
            type: string
          description: The number's display name in the Pilot Status dashboard.
      responses:
        '200':
          description: Success — provider-native response body.
          content:
            application/json:
              schema:
                type: object
                description: Invite link and raw invite code for the group.
                properties:
                  inviteUrl:
                    type: string
                    description: Full https://chat.whatsapp.com invite link.
                  inviteCode:
                    type: string
                    description: Raw invite code (path segment of the invite link).
              example:
                inviteUrl: https://chat.whatsapp.com/HkQ1a2B3c4D5e6F7g8H9i0
                inviteCode: HkQ1a2B3c4D5e6F7g8H9i0
        default:
          description: Error — provider or layer error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  response:
                    type: object
              example:
                status: 400
                error: Bad Request
                message: Invalid payload
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Your Pilot Status API key (ps_...). Evolution GO also accepts
        `Authorization: Bearer <key>`.

````