---
title: "Get info about an invite code (no join)"
method: GET
path: "/v1/group/inviteInfo/{instance}"
tags: ["Group"]
---

# Get info about an invite code (no join)

`GET /v1/group/inviteInfo/{instance}`

## Request

- Base URL: `http://localhost:8080`
- URL: `http://localhost:8080/v1/group/inviteInfo/{instance}`
- Auth: API key in header `apikey`

## Path parameters

- `instance` string, required

## Query parameters

- `inviteCode` string, required

## Response `200`

OK

- WhatsmiauGroupInfoResponse
  - `announce` boolean
  - `creation` integer
  - `desc` string
  - `descId` string
  - `ephemeral` integer
  - `groupAddMode` string
  - `id` string
  - `isCommunity` boolean
  - `isCommunityAnnounce` boolean
  - `joinApprovalMode` boolean
  - `linkedParent` string
  - `memberAddMode` string
  - `owner` string
  - `participants` WhatsmiauGroupParticipantResponse[]
    - `displayName` string
    - `error` integer
    - `isAdmin` boolean
    - `isSuperAdmin` boolean
    - `jid` string
    - `lid` string
  - `restrict` boolean
  - `size` integer
  - `subject` string
  - `subjectOwner` string
  - `subjectTime` integer

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `410`: Gone
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-07-18** `f812473c5a89`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/changes/v1/group/inviteInfo/:instance/get.md)

---

[API](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api.md) - [All operations](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/llms.txt) - [OpenAPI document](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/revisions/b425ec589eb0?raw)