Skip to main content

Get event​

Get organized event by ID

Path Parameters
    companyID companyID required

    The id of the company

    eventID eventID required

    The id of the event

Responses

An event object

Schema
    id string

    Unique ID of the event

    createdAt date-time

    Date the event was created

    updatedAt date-time

    Date the event was last updated

    title string

    Title of the event

    type string

    Possible values: [celebration, breakfast, lunch, drink, sport, meetup, onboarding, wellness, fun, allHands, other]

    Type of the event

    code string nullable

    Analytics code for admins

    description string

    Description of the event (in HTML)

    location string

    Possible values: [IN_PERSON, ONLINE]

    Location of the event

    startTime date-time

    Start time of the event (UTC)

    endTime date-time

    End time of the event (UTC)

    timeZone string nullable

    Time zone of the event

    capacity integer nullable

    Capacity of the event

    organizers string[]

    List of organizers of the event

    audience object

    Audience target of the event

    inviteOnly boolean

    Whether the event is invite only

    filters object[]

    List of filters to target the audience

  • Array [
    • key string

    Key of the filter

    value string

    Value of the filter

  • ]
    • participants string[]

    List of participants of the event

    waitlist string[]

    List of users on the waitlist

    declined string[]

    List of users who declined the event

    callUrl string nullable

    Call URL of the event

    address object nullable

    Address of the event

    main string

    Main text

    secondary string

    Secondary text

    formattedAddress string nullable

    Formatted address

    calendar object nullable

    Calendar details of the event

    google object nullable

    Google Calendar details

    id string

    Unique ID of the event in Google Calendar

    meetingRoomEmails string[] nullable

    List of meeting room added to the calendar event

    microsoft object nullable

    Microsoft Outlook details

    id string

    Unique ID of the event in Microsoft Outlook

    meetingRoomEmails string[] nullable

    List of meeting room added to the calendar event

    link string

    Link to the event

Loading...