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",
        "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"
                  }
                ]
              }
            ]
          }
        ],
        "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"
                  }
                ]
              }
            ]
          }
        ],
        "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,
        "cover_image_url": "<string>",
        "published_to": [
          {
            "slack_channel_id": "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.",
            "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",
            "slack_profile": {
              "deprecated": true,
              "warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
              "id": "U088HCYD418",
              "is_admin": false,
              "is_bot": false,
              "first_name": "John",
              "last_name": "Doe",
              "email": "[email protected]",
              "image_72": "https://example.com/image72.png",
              "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.",
            "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",
            "slack_profile": {
              "deprecated": true,
              "warning": "The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.",
              "id": "U088HCYD418",
              "is_admin": false,
              "is_bot": false,
              "first_name": "John",
              "last_name": "Doe",
              "email": "[email protected]",
              "image_72": "https://example.com/image72.png",
              "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
required

The page number (0-indexed)

​
per_page
integer
required

The number of records per page

​
time_filter
enum<string>
default:
upcoming

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
​
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
​
published_to_site
boolean | null

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 | null

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

Response

200
application/json
Gets a list of calendar events in the community
​
success
boolean
required
​
data
object
required

Was this page helpful?

Assign a badge to a userCreate a calendar event