Calendar Events
Get a calendar event
Calendar Events
Get a calendar event
Get a calendar event
GET
/
admin
/
v0
/
calendar_events
/
{calendar_event_id}
{
"success": true,
"data": {
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Minimum length:
1
Response
200
application/json
Gets a calendar event
Whether the the event attendee list is public
Whether the event registration button is enabled
Whether the event is published to the companion site
Whether the event triggers the relevant webhooks
Custom metadata to be included in data emitted to the subscribed webhook(s)
The URL slug for the event.
The event status.
Available options:
draft
, needs_approval
, published
The user(s) featured as a host for the event.
A user profile
Available options:
The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.
The user(s) featured as a speaker for the event.
A user profile
Available options:
The slack_profile field object is deprecated and will be removed in a future release. Use the top-level slack fields instead.
Was this page helpful?
{
"success": true,
"data": {
"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"
}
]
}
}