---
title: "Get the whole office incl. rooms"
method: GET
path: "/api/office"
tags: ["API"]
---

# Get the whole office incl. rooms

`GET /api/office`

## Response `200`

Success

- Office
  - `groups` Group[], required
    - `id` string, required
    - `name` string, required
    - `disabledAfter` string — ISO 8601 string
    - `disabledBefore` string — ISO 8601 string
    - `joinableAfter` string — ISO 8601 string
    - `groupJoin` GroupJoinConfig
      - `minimumParticipantCount` number, required — Minimum number of participants in a room. When this count has been reached, the next one will be filled.
      - `title` string, required — Title that is displayed as the header of the group join card.
      - `subtitle` string — Subtitle that is displayed underneath the header of the group join card.
      - `description` string, required — Description that explains the group join functionality to users.
  - `rooms` Room[], required
    - `meetingId` string, required
    - `roomId` string
    - `group` string
    - `name` string, required
    - `subtitle` string
    - `description` string
    - `joinUrl` string
    - `temporary` boolean
    - `links` Link[]
      - `href` string, required
      - `text` string, required
      - `icon` string
    - `icon` string

## Other responses

- `500` — Internal error

---

[API](https://skmtc.dev/tng/apis/virtual-office.md) · [All operations](https://skmtc.dev/tng/apis/virtual-office/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tng/virtual-office/revisions/5cc6ee797979/schema)