# Subuser Invites endpoints (Client API: game servers)

> 5 FeatherPanel Client API: game servers endpoints from user/server/subuser-invites.php: methods, paths, auth, permissions, rate limits, parameters and responses.

Source: https://featherpanel.com/docs/api/reference/user/server/subuser-invites/

Defined in [`backend/app/routes/user/server/subuser-invites.php`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/server/subuser-invites.php). Authentication used here: **Server access**, **Signed-in user**. Read [Authentication](https://featherpanel.com/docs/api/authentication/) for how to send credentials and [Rate limits and errors](https://featherpanel.com/docs/api/rate-limits-and-errors/) for the response envelope.

Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.

## Endpoints

### GET `/api/user/servers/{uuidShort}/subuser-invites`

- Auth: Server access
- Default rate limit: 20 / minute (`user-server-subuser-invites`)
- Route name: `session-server-subuser-invites`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/server/subuser-invites.php#L24)

**Active invite links**

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuidShort` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/subuser-invites" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

Responses: `200` Invites

### POST `/api/user/servers/{uuidShort}/subuser-invites`

- Auth: Server access
- Default rate limit: 20 / minute (`user-server-subuser-invites`)
- Route name: `session-server-subuser-invites`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/server/subuser-invites.php#L24)

**Active invite links**

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuidShort` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/subuser-invites" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

Responses: `200` Invites

### DELETE `/api/user/servers/{uuidShort}/subuser-invites/{inviteId}`

- Auth: Server access
- Default rate limit: 20 / minute (`user-server-subuser-invites`)
- Route name: `session-server-subuser-invite-revoke`
- Controller: [`SubuserInviteController::revoke`](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/Controllers/User/Server/SubuserInviteController.php)
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/server/subuser-invites.php#L40)

**Revoke an invite link**

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuidShort` | path | \- | yes |  |
| `inviteId` | path | \- | yes |  |

```bash
curl -X DELETE "$PANEL_URL/api/user/servers/$UUID_SHORT/subuser-invites/$INVITE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

Responses: `200` Revoked

### GET `/api/user/subuser-invites/{token}`

- Auth: Signed-in user
- Default rate limit: 10 / minute (`user-subuser-invite`)
- Route name: `user-subuser-invite`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/server/subuser-invites.php#L53)

**Preview an invite link**

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `token` | path | \- | yes |  |

```bash
curl -X GET "$PANEL_URL/api/user/subuser-invites/$TOKEN" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

Responses: `200` Invite preview

### POST `/api/user/subuser-invites/{token}`

- Auth: Signed-in user
- Default rate limit: 10 / minute (`user-subuser-invite`)
- Route name: `user-subuser-invite`
- [route source](https://github.com/MythicalLTD/FeatherPanel/blob/15b94e9fc9df233123706b47c42728b81e48cb3d/backend/app/routes/user/server/subuser-invites.php#L53)

**Preview an invite link**

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `token` | path | \- | yes |  |

```bash
curl -X POST "$PANEL_URL/api/user/subuser-invites/$TOKEN" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"
```

Responses: `200` Invite preview