---
url: /apidocs/playground.md
---
## Playground API

| Endpoint | Method | Description |
|-----|-----|-----|
| [playground:getUserGroups](#playground-get-user-groups) | websocket | Playground: get user groups |
| [playground:createGroup](#playground-create-group) | websocket | Playground: create group |
| [playground:updateGroup](#playground-update-group) | websocket | Playground: update group |
| [playground:deleteGroup](#playground-delete-group) | websocket | Playground: delete group |
| [playground:addGroupParticipant](#playground-add-group-participant) | websocket | Playground: add group participant |
| [playground:deleteGroupParticipant](#playground-delete-group-participant) | websocket | Playground: delete group participant |
| [playground:refreshGroupInviteData](#playground-refresh-group-invite-data) | websocket | Playground: refresh group invite data |
| [playground:groupCreated](#playground-group-created-event) | websocketEvent | Playground group created event |
| [playground:groupUpdated](#playground-group-updated-event) | websocketEvent | Playground group updated event |
| [playground:groupDeleted](#playground-group-deleted-event) | websocketEvent | Playground group deleted event |
| [playground:groupParticipantAdded](#playground-group-participant-added-event) | websocketEvent | Playground group participant added event |
| [playground:groupParticipantDeleted](#playground-group-participant-deleted-event) | websocketEvent | Playground group participant deleted event |

### Playground: get user groups

**Method:** websocket

**Endpoint:** playground:getUserGroups

**Description:** Endpoint returns list of user playground groups.

**Request:**

**Response:**

### Playground: create group

**Method:** websocket

**Endpoint:** playground:createGroup

**Request:**

**Response:**

### Playground: update group

**Method:** websocket

**Endpoint:** playground:updateGroup

**Request:**

**Response:**

### Playground: delete group

**Method:** websocket

**Endpoint:** playground:deleteGroup

**Request:**

**Response:**

### Playground: add group participant

**Method:** websocket

**Endpoint:** playground:addGroupParticipant

**Request:**

**Response:**

### Playground: delete group participant

**Method:** websocket

**Endpoint:** playground:deleteGroupParticipant

**Request:**

**Response:**

### Playground: refresh group invite data

**Method:** websocket

**Endpoint:** playground:refreshGroupInviteData

**Description:** Endpoint generates new `inviteCode` and `inviteLink` for a playground group.

**Request:**

**Response:**

### Playground group created event

**Event:** playground:groupCreated

**Data:**

### Playground group updated event

**Event:** playground:groupUpdated

**Data:**

### Playground group deleted event

**Event:** playground:groupDeleted

**Data:**

### Playground group participant added event

**Event:** playground:groupParticipantAdded

**Data:**

### Playground group participant deleted event

**Event:** playground:groupParticipantDeleted

**Data:**