Listing all waiting rooms¶

Note

Example:/waiting-rooms?domainId=0000001``/waiting-rooms?subDomainName=myrademo.com

Send a GET request to the /waiting-rooms endpoint.

Description¶

The List-Waiting-Rooms request allows the user to request a list of all waiting rooms of the organisation.

Requirements¶

Values of the request: Domain ID {domainId}

Objects: none

Request¶

To request a list of all waiting rooms, add a parameter domainID=<ID of the Domain> or a parameter subDomainName=<Subdomain name> to the path of the request.

As a result, the user gets one or more objects WaitingRoomVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`name`	The name of the waiting room.	`string`
`maxConcurrent`	The maximum number of visitors allowed to access the customer infrastructure at the same time. As soon as the value is exceeded, each additional visitor is directed to the waiting room.	`integer`
`sessionTimeout`	The duration in seconds for which an inactive session can access the customer infrastructure. If the session is not accessed again within this time, access for the session is disabled.	`integer`
`waitRefresh`	The duration in seconds after which the waiting page is reloaded. If the session is not accessed again after the third reload, it is removed from the queue.	`integer`
`paths`	A path within the apex domain or subdomain to which the waiting room is to apply. The path must be defined as a regular expression. The default value in the PATH field is .. If the default value . is used as the path, the waiting pages and settings of all waiting rooms with a path of the corresponding apex domain or subdomain are overwritten.	`string`
`subDomainName`	The name of the subdomain for which the waiting room is available.	`string`
`vhostId`	The ID of the subdomains for which the waiting room is available.	`integer`
`content`	The HTML-Code for the waiting room template.	`string`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "name": "string",
    "maxConcurrent": 0,
    "sessionTimeout": 0,
    "waitRefresh": 0,
    "paths": "string",
    "subDomainName": "string",
    "vhostId": 0,
    "content": "string",
    "id": 0,
    "modified": "2026-01-01T00:00:00+00:00",
    "created": "2026-01-01T00:00:00+00:00"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.