---
title: List events
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Waiting Rooms](https://developers.cloudflare.com/api/resources/waiting_rooms)
[Events](https://developers.cloudflare.com/api/resources/waiting_rooms/subresources/events)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# List events
GET/zones/{zone\_id}/waiting\_rooms/{waiting\_room\_id}/events
Lists events for a waiting room.
##### Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
**Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`Waiting Rooms Read``Waiting Rooms Write`
##### P ath ParametersExpand Collapse
zone\_id: string
Identifier.
maxLength32
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
waiting\_room\_id: string
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20waiting_room_id%20%3E%20(schema)>)
##### Q uery ParametersExpand Collapse
page: optional number
Page number of paginated results.
minimum1
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>)
per\_page: optional number
Maximum number of results per page. Must be a multiple of 5.
maximum1000
minimum5
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional array of Event { id, created\_on, custom\_page\_html, 15 more }
id: optional string
Link to this property
created\_on: optional string
formatdate-time
Link to this property
custom\_page\_html: optional string
If set, the event will override the waiting room’s custom_page_html property while it is active. If null, the event will inherit it.
Link to this property
description: optional string
A note that you can use to add more details about the event.
Link to this property
disable\_session\_renewal: optional boolean
If set, the event will override the waiting room’s disable_session_renewal property while it is active. If null, the event will inherit it.
Link to this property
event\_end\_time: optional string
An ISO 8601 timestamp that marks the end of the event.
Link to this property
event\_start\_time: optional string
An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event’s configuration. The start time must be at least one minute before event_end_time.
Link to this property
modified\_on: optional string
formatdate-time
Link to this property
name: optional string
A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
Link to this property
new\_users\_per\_minute: optional number
If set, the event will override the waiting room’s new_users_per_minute property while it is active. If null, the event will inherit it. This can only be set if the event’s total_active_users property is also set.
maximum2147483647
minimum200
Link to this property
prequeue\_start\_time: optional string
An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before event_start_time.
Link to this property
queueing\_method: optional string
If set, the event will override the waiting room’s queueing_method property while it is active. If null, the event will inherit it.
Link to this property
session\_duration: optional number
If set, the event will override the waiting room’s session_duration property while it is active. If null, the event will inherit it.
maximum30
minimum1
Link to this property
shuffle\_at\_event\_start: optional boolean
If enabled, users in the prequeue will be shuffled randomly at the event_start_time. Requires that prequeue_start_time is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the queueing_method during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.
Link to this property
suspended: optional boolean
Suspends or allows an event. If set to true, the event is ignored and traffic will be handled based on the waiting room configuration.
Link to this property
total\_active\_users: optional number
If set, the event will override the waiting room’s total_active_users property while it is active. If null, the event will inherit it. This can only be set if the event’s new_users_per_minute property is also set.
maximum2147483647
minimum200
Link to this property
turnstile\_action: optional "log"or "infinite\_queue"
If set, the event will override the waiting room’s turnstile_action property while it is active. If null, the event will inherit it.
One of the following:
"log"
Link to this property
"infinite\_queue"
Link to this property
Link to this property
turnstile\_mode: optional "off"or "invisible"or "visible\_non\_interactive"or "visible\_managed"
If set, the event will override the waiting room’s turnstile_mode property while it is active. If null, the event will inherit it.
One of the following:
"off"
Link to this property
"invisible"
Link to this property
"visible\_non\_interactive"
Link to this property
"visible\_managed"
Link to this property
Link to this property
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
result\_info: optional object {count, page, per\_page, 2 more }
count: optional number
Total number of results for the requested service.
Link to this property
page: optional number
Current page within paginated list of results.
Link to this property
per\_page: optional number
Number of results per page of results.
Link to this property
total\_count: optional number
Total results available without any search parameters.
Link to this property
total\_pages: optional number
The number of total pages in the entire result set.
Link to this property
[Link to this property](<#(resource)%20waiting_rooms.events%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### List events
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms/$WAITING_ROOM_ID/events \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "25756b2dfe6e378a06b033b670413757",
"created_on": "2014-01-01T05:20:00.12345Z",
"custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
"description": "Production event - DO NOT MODIFY",
"disable_session_renewal": true,
"event_end_time": "2021-09-28T17:00:00Z",
"event_start_time": "2021-09-28T15:30:00Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "production_webinar_event",
"new_users_per_minute": 200,
"prequeue_start_time": "2021-09-28T15:00:00Z",
"queueing_method": "random",
"session_duration": 1,
"shuffle_at_event_start": true,
"suspended": true,
"total_active_users": 200,
"turnstile_action": "log",
"turnstile_mode": "off"
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "25756b2dfe6e378a06b033b670413757",
"created_on": "2014-01-01T05:20:00.12345Z",
"custom_page_html": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
"description": "Production event - DO NOT MODIFY",
"disable_session_renewal": true,
"event_end_time": "2021-09-28T17:00:00Z",
"event_start_time": "2021-09-28T15:30:00Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"name": "production_webinar_event",
"new_users_per_minute": 200,
"prequeue_start_time": "2021-09-28T15:00:00Z",
"queueing_method": "random",
"session_duration": 1,
"shuffle_at_event_start": true,
"suspended": true,
"total_active_users": 200,
"turnstile_action": "log",
"turnstile_mode": "off"
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}
```