GET
/
admin
/
v0
/
calendar_events
{
  "success": true,
  "data": {
    "page": 0,
    "per_page": 10,
    "count": 10,
    "total_records": 100,
    "total_pages": 10,
    "has_next": true,
    "records": [
      {
        "id": "1fj0vm1dgnh8",
        "created_at": "2024-02-01 04:04:39.198523+00",
        "updated_at": "2024-02-01 04:04:39.198523+00",
        "allow_public_guest_list": false,
        "description_slack_blocks": [
          {
            "type": "rich_text",
            "elements": [
              {
                "type": "rich_text_section",
                "elements": [
                  {
                    "text": "This is the event description.",
                    "type": "text"
                  }
                ]
              }
            ]
          }
        ],
        "description_slack_blocks_references": {
          "mentioned_slack_users": [
            {
              "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
              "preferred_name": "John D.",
              "slack_user_id": "U088HCYD418"
            }
          ],
          "mentioned_slack_channels": [
            {
              "slack_channel": {
                "id": "C088TB6CRL4",
                "name": "general"
              },
              "feed": {
                "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
                "label": "My Feed",
                "slug": "my-feed"
              }
            }
          ],
          "custom_emojis": [
            {
              "alias": "<string>",
              "name": "wow",
              "url": "https://example.com/wow.png"
            }
          ],
          "urls": [
            {
              "order_seen": 0,
              "is_embedded_media": false,
              "is_image": true,
              "is_video": false,
              "url": "https://example.com/tacos.png"
            }
          ]
        },
        "enable_registration_button": true,
        "end_date": "2025-01-07T15:30:00-08:00",
        "external_speakers": "John Doe, Jane Doe",
        "is_unlisted": true,
        "link": "https://example.com/my-event",
        "location": "1 Market Street, San Francisco, CA",
        "luma_event_id": "https://lu.ma/event/evt-6pGPLeDBObis0G4",
        "publish_to_site": true,
        "triggers_webhooks": true,
        "recap_slack_blocks": [
          {
            "type": "rich_text",
            "elements": [
              {
                "type": "rich_text_section",
                "elements": [
                  {
                    "text": "This is the event recap.",
                    "type": "text"
                  }
                ]
              }
            ]
          }
        ],
        "recap_slack_blocks_references": {
          "mentioned_slack_users": [
            {
              "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
              "preferred_name": "John D.",
              "slack_user_id": "U088HCYD418"
            }
          ],
          "mentioned_slack_channels": [
            {
              "slack_channel": {
                "id": "C088TB6CRL4",
                "name": "general"
              },
              "feed": {
                "id": "91795199-9d00-47c7-bd6e-d4049bb63451",
                "label": "My Feed",
                "slug": "my-feed"
              }
            }
          ],
          "custom_emojis": [
            {
              "alias": "<string>",
              "name": "wow",
              "url": "https://example.com/wow.png"
            }
          ],
          "urls": [
            {
              "order_seen": 0,
              "is_embedded_media": false,
              "is_image": true,
              "is_video": false,
              "url": "https://example.com/tacos.png"
            }
          ]
        },
        "recording_link": "https://www.youtube.com/watch?v=abc123",
        "webhook_custom_metadata": "third-party-event-id",
        "show_end_date": true,
        "slug": "my-event",
        "start_date": "2025-01-07T15:00:00-07:00",
        "status": "draft",
        "title": "My Event",
        "use_registration_btn_as_link": true,
        "attendees_count": 10,
        "cover_image_url": "<string>",
        "published_to": [
          {
            "slack_channel_id": "C088Q1MG0LZ",
            "slack_message_permalink": "https://my-slack-domain.slack.com/archives/C088Q1MG0LZ/p1737340193466182?thread_ts=1737340593.461179&cid=C088Q1MG0LZ",
            "feed_id": "91795199-9d00-47c7-bd6e-d4049bb63451"
          }
        ],
        "hosts": [
          {
            "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
            "created_at": "2024-02-01 04:04:39.198523+00",
            "preferred_name": "John D.",
            "preferred_image_original": "https://example.com/image.png",
            "preferred_image_1024": "https://example.com/image1024.png",
            "preferred_image_512": "https://example.com/image512.png",
            "preferred_image_192": "https://example.com/image192.png",
            "preferred_image_72": "https://example.com/image72.png",
            "preferred_image_48": "https://example.com/image48.png",
            "preferred_image_32": "https://example.com/image32.png",
            "preferred_image_24": "https://example.com/image24.png",
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "slack_user_id": "U088HCYD418",
            "slack_is_admin": false,
            "slack_is_bot": false,
            "slack_first_name": "John",
            "slack_last_name": "Doe",
            "slack_image_72": "https://example.com/image72.png",
            "slack_image_original": "https://example.com/image.png"
          }
        ],
        "speakers": [
          {
            "profile_id": "03ff107d-099f-4426-81a6-a04690d7afz3",
            "created_at": "2024-02-01 04:04:39.198523+00",
            "preferred_name": "John D.",
            "preferred_image_original": "https://example.com/image.png",
            "preferred_image_1024": "https://example.com/image1024.png",
            "preferred_image_512": "https://example.com/image512.png",
            "preferred_image_192": "https://example.com/image192.png",
            "preferred_image_72": "https://example.com/image72.png",
            "preferred_image_48": "https://example.com/image48.png",
            "preferred_image_32": "https://example.com/image32.png",
            "preferred_image_24": "https://example.com/image24.png",
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "slack_user_id": "U088HCYD418",
            "slack_is_admin": false,
            "slack_is_bot": false,
            "slack_first_name": "John",
            "slack_last_name": "Doe",
            "slack_image_72": "https://example.com/image72.png",
            "slack_image_original": "https://example.com/image.png"
          }
        ],
        "tags": [
          {
            "id": "12345678-90ab-cdef-1234-567890ab",
            "created_at": "2024-02-01 04:04:39.198523+00",
            "tag_group_id": "12345678-90ab-cdef-1234-567890ab",
            "label": "My Tag"
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

The page number (0-indexed)

Example:

0

​
per_page
integer

The number of records per page

Example:

10

​
time_filter
enum<string>

Filters results to events whose date and time fall entirely or partially within the specified time frame category. If no filter specified, all events are returned.

Available options:
upcoming,
past
Example:

"upcoming"

​
date_filter
string

Overrides the time_filter parameter. Filters results to events that occur entirely or partially within the bounds of the specified date.

Example:

"2025-01-07T15:00:00-07:00"

​
status
enum<string>
default:published

Filters results to events with the specified status. If no filter specified, all events are returned.

Available options:
draft,
needs_approval,
published
Example:

"published"

​
published_to_site
boolean

Filters results based on whether the events are published to the site. If no filter specified, all events are returned regardless of site publication configuration.

​
is_unlisted
boolean

Filters results based on whether the events are unlisted. If no filter specified, all events are returned.

​
feed_id
string

The id of the active Feed that the calendar events are published to. If no Feed filter is specified, all events are returned.

Response

200
application/json

Gets a list of calendar events in the community

The response is of type object.