Get a list of calendar events in the community

GET

admin

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

The page number (0-indexed)

Example:

0

per_page

integer

The number of records per page

Example:

10

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

Example:

"upcoming"

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.

Response

200

application/json

Gets a list of calendar events in the community

success

boolean

required

data

object

required

data.page

number

required

The current page number (0-indexed)

Required range: x >= 0

Example:

0

data.per_page

number

required

The number of records per page

Required range: 1 <= x <= 20

Example:

10

data.count

number

required

The number of records in the current page

Required range: x >= 0

Example:

10

data.total_records

number

required

The total number of records

Required range: x >= 0

Example:

100

data.total_pages

number

required

The total number of pages

Example:

10

data.has_next

boolean

required

Whether there is a next page of additional records after the current page

Example:

true

data.records

object[]

required

The list of records in the current page

Calendar Event

data.records.id

string

required

Example:

"1fj0vm1dgnh8"

data.records.created_at

string

required

Example:

"2024-02-01 04:04:39.198523+00"

data.records.allow_public_guest_list

boolean

required

Whether the the event attendee list is public

Example:

false

data.records.enable_registration_button

boolean

required

Whether the event registration button is enabled

Example:

true

data.records.end_date

string

required

Example:

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

data.records.external_speakers

string | null

required

Example:

"John Doe, Jane Doe"

data.records.is_unlisted

boolean

required

data.records.link

string | null

required

Example:

"https://example.com/my-event"

data.records.location

string | null

required

Example:

"1 Market Street, San Francisco, CA"

data.records.luma_event_id

string | null

required

Example:

"https://lu.ma/event/evt-6pGPLeDBObis0G4"

data.records.publish_to_site

boolean

required

Whether the event is published to the companion site

Example:

true

data.records.triggers_webhooks

boolean

required

Whether the event triggers the relevant webhooks

Example:

true

data.records.recording_link

string | null

required

Example:

"https://www.youtube.com/watch?v=abc123"

data.records.webhook_custom_metadata

string | null

required

Custom metadata to be included in data emitted to the subscribed webhook(s)

Example:

"third-party-event-id"

data.records.show_end_date

boolean

required

data.records.slug

string

required

The URL slug for the event.

Example:

"my-event"

data.records.start_date

string

required

Example:

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

data.records.status

enum<string>

required

The event status.

Available options:

draft,

needs_approval,

published

data.records.title

string

required

Example:

"My Event"

data.records.use_registration_btn_as_link

boolean

required

data.records.published_to

object[]

required

The Slack channel(s) and connected site feed(s), if any, that the event announcements are posted to when published.

data.records.hosts

object[]

required

List of profiles

data.records.hosts.profile_id

string

required

Example:

"03ff107d-099f-4426-81a6-a04690d7afz3"

data.records.hosts.created_at

string

required

Example:

"2024-02-01 04:04:39.198523+00"

data.records.hosts.preferred_name

string

required

Example:

"John D."

data.records.hosts.first_name

string | null

required

Example:

"John"

data.records.hosts.last_name

string | null

required

Example:

"Doe"

data.records.hosts.slack_user_id

string

required

Example:

"U088HCYD418"

data.records.hosts.slack_is_admin

boolean

required

Example:

false

data.records.hosts.slack_is_bot

boolean

required

Example:

false

data.records.hosts.slack_first_name

string | null

required

Example:

"John"

data.records.hosts.slack_last_name

string | null

required

Example:

"Doe"

data.records.hosts.slack_image_72

string | null

required

Example:

"https://example.com/image72.png"

data.records.hosts.slack_image_original

string | null

required

Example:

"https://example.com/image.png"

data.records.hosts.slack_profile

object

required

data.records.hosts.email

string | null

Example:

"[email protected]"

data.records.speakers

object[]

required

List of profiles

data.records.speakers.profile_id

string

required

Example:

"03ff107d-099f-4426-81a6-a04690d7afz3"

data.records.speakers.created_at

string

required

Example:

"2024-02-01 04:04:39.198523+00"

data.records.speakers.preferred_name

string

required

Example:

"John D."

data.records.speakers.first_name

string | null

required

Example:

"John"

data.records.speakers.last_name

string | null

required

Example:

"Doe"

data.records.speakers.slack_user_id

string

required

Example:

"U088HCYD418"

data.records.speakers.slack_is_admin

boolean

required

Example:

false

data.records.speakers.slack_is_bot

boolean

required

Example:

false

data.records.speakers.slack_first_name

string | null

required

Example:

"John"

data.records.speakers.slack_last_name

string | null

required

Example:

"Doe"

data.records.speakers.slack_image_72

string | null

required

Example:

"https://example.com/image72.png"

data.records.speakers.slack_image_original

string | null

required

Example:

"https://example.com/image.png"

data.records.speakers.slack_profile

object

required

data.records.speakers.email

string | null

Example:

"[email protected]"

data.records.description_slack_blocks

object[] | null

The message in Slack blocks format for rich text input element.

Example:

[
  {
    "type": "rich_text",
    "elements": [
      {
        "type": "rich_text_section",
        "elements": [
          {
            "text": "This is the event description.",
            "type": "text"
          }
        ]
      }
    ]
  }
]

data.records.recap_slack_blocks

object[] | null

The message in Slack blocks format for rich text input element.

Example:

[
  {
    "type": "rich_text",
    "elements": [
      {
        "type": "rich_text_section",
        "elements": [
          {
            "text": "This is the event recap.",
            "type": "text"
          }
        ]
      }
    ]
  }
]

data.records.cover_image_url

string | null

data.records.tags

object[] | null

Tag

Was this page helpful?

Add a user as a member of a group Create a calendar event

{
  "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"
          }
        ]
      }
    ]
  }
}

Badge

Feeds

Files

Groups

Calendar Events

Search

Webhooks

Get a list of calendar events in the community

Authorizations

Query Parameters

Response