Events

List calendar events

GET

https://discourse.example.com/discourse-post-event/events.json

curl -X GET 'https://discourse.example.com/discourse-post-event/events.json'

const response = await fetch('https://discourse.example.com/discourse-post-event/events.json', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://discourse.example.com/discourse-post-event/events.json')
print(response.text)

200

{
  "events": [
    {
      "id": 0,
      "category_id": 0,
      "name": "string",
      "recurrence": "string",
      "recurrence_until": "2024-01-15T09:30:00Z",
      "starts_at": "2024-01-15T09:30:00Z",
      "ends_at": "2024-01-15T09:30:00Z",
      "rrule": "string",
      "show_local_time": true,
      "timezone": "string",
      "duration": "string",
      "all_day": true,
      "custom_fields": {},
      "post": {
        "id": 0,
        "post_number": 0,
        "url": "string",
        "category_slug": "string",
        "topic": {
          "id": 0,
          "title": "string",
          "tags": [
            "string"
          ],
          "tags_descriptions": {},
          "slug": "string"
        }
      },
      "occurrences": [
        {
          "starts_at": "string",
          "ends_at": "string"
        }
      ],
      "can_act_on_discourse_post_event": true,
      "can_update_attendance": true,
      "creator": {
        "id": 0,
        "username": "string",
        "name": "string",
        "avatar_template": "string"
      },
      "hosts": [
        {
          "id": 0,
          "username": "string",
          "name": "string",
          "avatar_template": "string",
          "title": "string"
        }
      ],
      "is_closed": true,
      "is_expired": true,
      "is_ongoing": true,
      "is_private": true,
      "is_public": true,
      "is_standalone": true,
      "minimal": true,
      "raw_invitees": [
        "string"
      ],
      "reminders": [
        {
          "value": 0,
          "unit": "string",
          "period": "before",
          "type": "string"
        }
      ],
      "sample_invitees": [
        {}
      ],
      "should_display_invitees": true,
      "stats": {},
      "status": "public",
      "url": "string",
      "description": "string",
      "description_html": "string",
      "location": "string",
      "url_restates_location": true,
      "watching_invitee": {},
      "chat_enabled": true,
      "channel": {},
      "livestream": true,
      "livestream_onebox": "string",
      "is_zoom_livestream": true,
      "recording_url": "string",
      "recording_onebox": "string",
      "max_attendees": 0,
      "at_capacity": true,
      "image_upload": {}
    }
  ]
}

Parameters

include_detailsstringtruefalsequery

Include detailed event information (creator, invitees, stats, etc.)

include_cardstringtruefalsequery

Include card fields without detailed event HTML or statistics

category_idintegerquery

Filter events by category ID

include_subcategoriesstringtruefalsequery

Include events from subcategories when filtering by category

post_idintegerquery

Filter to events associated with a specific post ID

attending_userstringquery

Filter to events where the specified user (username) has RSVP'd as going

beforestring<date-time>query

Return events starting before this date/time (ISO 8601 format)

afterstring<date-time>query

Return events starting after this date/time (ISO 8601 format)

orderstringascdescquery

Sort order for events by start date (default: asc)

limitinteger[1, 200]query

Maximum number of events to return (default: 200)

tagsArray<string>query

Filter to events whose topic has every specified tag

searchstringquery

Search event names, descriptions, and locations

statusstringpublicprivatestandalonequery

Filter by event attendance status

Response

200OKobject

success response (detailed)

Response fields application/json

eventsArray<object>required

Show child attributes

idintegerrequired

category_idinteger | nullrequired

namestring | null

recurrencestring | null

recurrence_untilstring<date-time> | null

starts_atstring<date-time> | nullrequired

ends_atstring<date-time> | nullrequired

rrulestring

show_local_timebooleanrequired

timezonestring | nullrequired

durationstring

all_dayboolean

custom_fieldsobject | null

postobjectrequired

Show child attributes

idintegerrequired

post_numberintegerrequired

urlstringrequired

category_slugstringrequired

topicobjectrequired

Show child attributes

idintegerrequired

titlestringrequired

tagsArray<string>required

tags_descriptionsobjectrequired

slugstringrequired

occurrencesArray<object>required

Show child attributes

starts_atstring | nullrequired

ends_atstring | nullrequired

can_act_on_discourse_post_eventboolean | nullrequired

can_update_attendanceboolean | nullrequired

creatorobject

Show child attributes

idintegerrequired

usernamestringrequired

namestring | null

avatar_templatestringrequired

hostsArray<object>

Show child attributes

idintegerrequired

usernamestringrequired

namestring | null

avatar_templatestringrequired

titlestring | null

is_closedbooleanrequired

is_expiredbooleanrequired

is_ongoingbooleanrequired

is_privatebooleanrequired

is_publicbooleanrequired

is_standalonebooleanrequired

minimalboolean | null

raw_inviteesArray<string> | null

remindersArray<object>

Show child attributes

valueintegerrequired

unitstringrequired

periodstringbeforeafterrequired

typestringrequired

sample_inviteesArray<object>

should_display_inviteesbooleanrequired

statsobject

statusstringpublicprivatestandalonerequired

urlstring

descriptionstring | null

description_htmlstring | null

locationstring | null

url_restates_locationboolean

watching_inviteeobject | null

chat_enabledboolean | null

channelobject

livestreamboolean

livestream_oneboxstring | null

is_zoom_livestreamboolean

recording_urlstring

recording_oneboxstring | null

max_attendeesinteger | null

at_capacitybooleanrequired

image_uploadobject | null

Docs by Sourcey