---
title: "Get the welcome message from a signaling server"
method: GET
path: "/ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/welcome/{serverId}"
tags: ["settings"]
---

# Get the welcome message from a signaling server

`GET /ocs/v2.php/apps/spreed/api/{apiVersion}/signaling/welcome/{serverId}`

Only available for logged-in users because guests can not use the apps right now.
This endpoint requires admin access

## Path parameters

- `apiVersion` 'v3', required
- `serverId` integer, required

## Headers

- `OCS-APIRequest` boolean, required

## Response `200`

Welcome message returned

- object
  - `ocs` object, required
    - `meta` OCSMeta, required
      - `status` string, required
      - `statuscode` integer, required
      - `message` string
      - `totalitems` string
      - `itemsperpage` string
    - `data` object, required
      - `version` string, required
      - `warning` string
      - `features` string[]

## Other responses

- `401` — Current user is not logged in
- `403` — Logged in account must be an admin
- `404` — Signaling server not found
- `500`

## Changes

- **2025-08-30** `c4bb3681740a` — 2 info
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
- **2025-05-19** `308b32d4717b` — 3 info
  - added the optional property `ocs/data/features` to the response with the `200` status
  - added the optional property `ocs/data/warning` to the response with the `200` status
  - added the required property `ocs/data/version` to the response with the `200` status
- **2024-11-20** `5a33db2532e3` — 1 breaking
  - the response property `ocs/data` became nullable for the status `404`
- **2024-04-15** `4c7bb1db8509` — 1 info
  - api operation id `settings-get-welcome-message` removed and replaced with `signaling-get-welcome-message`

[Change history](https://skmtc.dev/nextcloud/apis/spreed-administration/changes/ocs/v2.php/apps/spreed/api/:apiVersion/signaling/welcome/:serverId/get.md)

---

[API](https://skmtc.dev/nextcloud/apis/spreed-administration.md) · [All operations](https://skmtc.dev/nextcloud/apis/spreed-administration/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nextcloud/spreed-administration/revisions/470ddf348b55/schema)