---
title: "GET /connections/{phoneNumber}/group-metadata"
method: GET
path: "/connections/{phoneNumber}/group-metadata"
tags: ["Connections"]
---

# GET /connections/{phoneNumber}/group-metadata

`GET /connections/{phoneNumber}/group-metadata`

## Request

- Base URL: `http://localhost:3025`
- URL: `http://localhost:3025/connections/{phoneNumber}/group-metadata`
- Auth: API key in header `x-api-key`

## Path parameters

- `phoneNumber` string, required

## Query parameters

- `jid` string, required

## Response `200`

Group metadata retrieved successfully

- object
  - `id` string: Group JID
  - `addressingMode` string: Addressing mode of the group
  - `subject` string: Group name/subject
  - `subjectOwner` string: JID of the user who set the subject
  - `subjectOwnerPn` string: Phone number JID of the subject owner
  - `subjectTime` number: Timestamp when subject was set
  - `size` number: Number of participants in the group
  - `creation` number: Timestamp when the group was created
  - `owner` string: JID of the group owner
  - `ownerPn` string: Phone number JID of the group owner
  - `owner_country_code` string: Country code of the group owner
  - `desc` string, nullable: Group description
  - `descId` string, nullable: Description ID
  - `descOwner` string, nullable: JID of the user who set the description
  - `descTime` number, nullable: Timestamp when description was set
  - `restrict` boolean: Whether only admins can change group settings
  - `announce` boolean: Whether only admins can send messages
  - `isCommunity` boolean: Whether the group is a community
  - `isCommunityAnnounce` boolean: Whether the group is a community announcement group
  - `joinApprovalMode` boolean: Whether join requests require admin approval
  - `memberAddMode` boolean: Whether members can add other members
  - `participants` object[]: List of group participants
    - `id` string: Participant JID
    - `phoneNumber` string: Participant phone number JID
    - `admin` string, nullable: Admin status: 'superadmin', 'admin', or null
  - `ephemeralDuration` number, nullable: Duration in seconds for disappearing messages

## Other responses

- `403`: Forbidden — the API key does not own this connection. Returned when a connection is bound to a different API key.
- `421`: Misdirected Request — in cluster mode, this instance does not own the connection. The owning instance id is in the x-baileys-owner header; a proxy re-routes the request there. Not returned for the explicit-takeover routes: POST /connections/{phoneNumber}, /import-session and /restart.

## Changes

- **2026-08-15** `533b3360e2e4`: 2 breaking, 7 warning, 4 info
  - removed the required property `data` from the response with the `200` status
  - removed the success response with the status `202`
  - removed the optional property `address` from the response with the `200` status
  - removed the optional property `business_hours` from the response with the `200` status
  - …9 more
- **2026-08-15** `80b5396ef493`: 2 info
  - added the non-success response with the status `422`
  - added the success response with the status `202`
- **2026-06-16** `da89554d2e38`: 13 info
  - added the non-success response with the status `409`
  - added the non-success response with the status `421`
  - added the optional property `data/capping_status` to the response with the `200` status
  - added the optional property `data/cycle_end_timestamp` to the response with the `200` status
  - …9 more
- **2026-03-20** `8632adf0286b`: 11 info
  - added the non-success response with the status `403`
  - added the non-success response with the status `404`
  - added the non-success response with the status `500`
  - added the optional property `address` to the response with the `200` status
  - …7 more
- **2026-02-05** `7590ffa6872f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/fazer-ai/apis/fazer-ai-baileys-api/changes/connections/:phoneNumber/group-metadata/get.md)

---

[API](https://skmtc.dev/fazer-ai/apis/fazer-ai-baileys-api.md) - [All operations](https://skmtc.dev/fazer-ai/apis/fazer-ai-baileys-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fazer-ai/apis/fazer-ai-baileys-api/revisions/322af11b310e?raw)