# Get group info

`GET /group.info`

## Description

Get information about a specific group by its ID or name.

Provide either `id` or `name`, not both.

**Required scope:** `group:read`

---

**OpenAPI Spec:** [chat-v1.json](https://developer.ro.am/chat-v1.json)

## Authentication

```
Authorization: Bearer YOUR_API_KEY
```

## Parameters

| Name | In | Type | Required | Description |
|------|-----|------|----------|-------------|
| `id` | query | string | No | The group's ID. Mutually exclusive with `name`. |
| `name` | query | string | No | The group's name. Mutually exclusive with `id`. Returns first match if multiple groups have the same name. |

## Responses

### 200 - Group info retrieved successfully

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | string | Yes | The group's unique identifier |
| `chatId` | string | No | The group's channel chat ID. Populated by `group.create` and `group.info` (the channel chat is created together with the group), and used to post to or read the channel via the chat endpoints.  |
| `name` | string | Yes | Name of the group |
| `type` | "standard" | "magicast" | "meeting" | "roam" | "onair" | "community" | Yes | The type of group: - `standard` - A regular channel created by users - `magicast` - A Magicast channel - `meeting` - A meeting channel - `roam` - The main Roam channel (one per workspace) - `onair` -  |
| `accessMode` | "public" | "private" | No | Whether the group is public or private |
| `groupManagement` | "allMembers" | "groupAdminsOnly" | No | Who can manage group settings and membership |
| `enforceThreadedMode` | boolean | No | Whether the group enforces threaded conversations |
| `dateCreated` | string | No | When the group was created |
| `imageUrl` | string | No | URL of the group's image |


#### Example Response

```json
{
  "id": "88bebce7-6cbb-4666-96f9-5c02d73e6661",
  "chatId": "757dfe66-37b4-4772-baa5-8c86ec68c176",
  "name": "Engineering Team",
  "type": "standard",
  "accessMode": "public",
  "groupManagement": "allMembers",
  "enforceThreadedMode": true,
  "dateCreated": "2025-02-20T14:30:00Z",
  "imageUrl": "https://ro.am/card-images/88bebce7-6cbb-4666-96f9-5c02d73e6661"
}
```

### 400 - Bad request. Common causes:
- Neither `id` nor `name` provided
- Both `id` and `name` provided


### 401 - Presented invalid authentication credentials.

### 403 - App does not have access to this group.

### 404 - Group not found.

### 405 - An unsupported method was requested.

### 500 - An internal error occurred.

---

*Machine-readable API documentation.*
*Full documentation: https://developer.ro.am/docs/api/group-info*