Get a list of calendar events in the community
Get a list of calendar events in the community.
{
"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"
}
],
"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"
}
],
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The page number (0-indexed)
0
The number of records per page
10
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.
upcoming, past "upcoming"
Filters results to events with the specified status. If no filter specified, all events are returned.
draft, needs_approval, published "published"
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.
Filters results based on whether the events are unlisted. If no filter specified, all events are returned.
Response
The current page number (0-indexed)
x >= 00
The number of records per page
1 <= x <= 2010
The number of records in the current page
x >= 010
The total number of records
x >= 0100
The total number of pages
10
Whether there is a next page of additional records after the current page
true
The list of records in the current page
Calendar Event
"1fj0vm1dgnh8"
"2024-02-01 04:04:39.198523+00"
Whether the the event attendee list is public
false
Whether the event registration button is enabled
true
"2025-01-07T15:30:00-08:00"
"John Doe, Jane Doe"
"https://example.com/my-event"
"1 Market Street, San Francisco, CA"
"https://lu.ma/event/evt-6pGPLeDBObis0G4"
Whether the event is published to the companion site
true
Whether the event triggers the relevant webhooks
true
"https://www.youtube.com/watch?v=abc123"
Custom metadata to be included in data emitted to the subscribed webhook(s)
"third-party-event-id"
The URL slug for the event.
"my-event"
"2025-01-07T15:00:00-07:00"
The event status.
draft, needs_approval, published "My Event"
The Slack channel(s) and connected site feed(s), if any, that the event announcements are posted to when published.
List of profiles
"03ff107d-099f-4426-81a6-a04690d7afz3"
"2024-02-01 04:04:39.198523+00"
"John D."
"John"
"Doe"
"U088HCYD418"
false
false
"John"
"Doe"
"https://example.com/image72.png"
"https://example.com/image.png"
List of profiles
"03ff107d-099f-4426-81a6-a04690d7afz3"
"2024-02-01 04:04:39.198523+00"
"John D."
"John"
"Doe"
"U088HCYD418"
false
false
"John"
"Doe"
"https://example.com/image72.png"
"https://example.com/image.png"
The message in Slack blocks format for rich text input element.
rich_text [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "This is the event description.",
"type": "text"
}
]
}
]
}
]
The message in Slack blocks format for rich text input element.
rich_text [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"text": "This is the event recap.",
"type": "text"
}
]
}
]
}
]
Tag
"12345678-90ab-cdef-1234-567890ab"
"2024-02-01 04:04:39.198523+00"
The ID of the Tag Group this tag belongs to
"12345678-90ab-cdef-1234-567890ab"
The label of the tag, unique within the Tag Group
"My Tag"
Was this page helpful?
{
"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"
}
],
"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"
}
],
"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"
}
]
}
]
}
}