events_get
events_get
Section titled “events_get”Category: events
Fetch a single scheduled event by id.
When to use
Section titled “When to use”- Inspect a specific event before modifying or deleting.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild that owns the event |
event_id | string | yes | Scheduled event id |
with_user_count | boolean | no | Include user_count in response |
Returns
Section titled “Returns”projected event shape with optional user_count. name/description/entity_metadata.location wrapped untrusted.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Discord scheduled event ID |
guild_id | string | yes | Discord guild (server) ID |
scheduled_start_time | string | yes | |
scheduled_end_time | unknown | yes | |
status | integer | yes | |
entity_type | integer | yes | |
channel_id | unknown | yes | |
creator_id | unknown | yes | |
user_count | integer | no | |
untrusted_text | string | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |