Get event by code

GET

/api/events/get-for-code

curl --request GET \
  --url https://api.eventpoint.io/api/events/get-for-code \
  --header 'x-api-key: <x-api-key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

projectcode

string

The project code.

eventcode

string

The event code.

Responses

200

OK

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

createdByUserId

string format: uuid

modifiedByUserId

null | string format: uuid

organizationId

null | string format: uuid

projectId

string format: uuid

baseType

Allowed values: Public Invitation Ticketed Registration Private Basic

eventTypeId

null | string format: uuid

eventSettingsId

null | string format: uuid

eventSettingsOverride

boolean

locationId

null | string format: uuid

timeslotId

null | string format: uuid

name

null | string

code

null | string

eid

null | string

location

null | string

description

null | string

notes

null | string

descriptionHtml

null | string

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

timezone

null | string

url

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

iCalUID

null | string

importedCalendarId

null | string

expectedAttendance

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

actualAttendance

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasWaitlist

boolean

waitlistSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maximumEventSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isDeclined

boolean

hasReminder

boolean

useDefaultReminder

boolean

reminderMins

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

status

Allowed values: Tentative Confirmed Cancelled

approvalStatus

Allowed values: Proposed Approved Declined UnderReview

visibility

Allowed values: Default Public Private Confidential

transparency

Allowed values: Opaque Transparent

durationMilliseconds

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationMinutes

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationHours

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationSeconds

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

start

null | string format: date-time

startTimezone

null | string

hasStartTime

boolean

end

null | string format: date-time

endTimezone

null | string

hasEndTime

boolean

startUtc

null | string format: date-time

endUtc

null | string format: date-time

utcOffset

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isAllDay

boolean

isMultiDay

boolean

isLocked

boolean

isRecurring

boolean

recurrenceId

null | string format: uuid

recursUntil

null | string format: date-time

recurrencePattern

null | string

organizerId

null | string format: uuid

creatorIsOrganizer

boolean

priority

Allowed values: Default Low High

sequence

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

socials

null | string

price

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

currency

null | string

publish

boolean

forceSchedule

boolean

isVirtual

boolean

customUrl

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

hEventDescriptorId

null | string format: uuid

isExpired

boolean

numberOfComments

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

reactionSummary

null | string

slug

null | string

locationData

null | string

externalId

null | string

category

null | string

hasChecklist

boolean

checkedInDate

null | string format: date-time

isDraft

null | boolean

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

organizer

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

name

null | string

firstName

null | string

lastName

null | string

email

null | string

contactEmail

null | string

phone

null | string

jobTitle

null | string

company

null | string

description

null | string

url

null | string

contactInformation

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

type

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

organizationId

null | string format: uuid

projectId

string format: uuid

name

null | string

code

null | string

description

null | string

baseType

Allowed values: Public Invitation Ticketed Registration Private Basic

eventSettingsId

null | string format: uuid

hasChecklist

boolean

hasMetaFields

boolean

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

publish

boolean

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

isLocked

boolean

isSubEventType

boolean

subEventLabel

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

timeslot

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

name

null | string

description

null | string

timeslotType

Allowed values: Timeslot Availability Exclusion

publish

boolean

start

null | string format: date-time

startTime

null | string

hasStartTime

boolean

end

null | string format: date-time

endTime

null | string

hasEndTime

boolean

startUtc

null | string format: date-time

endUtc

null | string format: date-time

timezone

null | string

startTimezone

null | string

endTimezone

null | string

isAllDay

boolean

isRecurring

boolean

recurrencePattern

null | string

intervalSeconds

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

useForAllEventTypes

boolean

daysOfWeek

One of:

null

null

string

string

tags

null | string

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

dti

object

start

null | string format: date-time

end

null | string format: date-time

isUtc

boolean

hasStartTime

boolean

hasEndTime

boolean

formattedStartTime

null | string

formattedEndTime

null | string

formattedTime

null | string

friendlyTimespan

null | string

formattedDay

null | string

formattedDayCompact

null | string

formattedDateTime

null | string

friendlyDate

null | string

timezone

object

id

null | string

hasIanaId

boolean

displayName

null | string

standardName

null | string

daylightName

null | string

baseUtcOffset

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

supportsDaylightSavingTime

boolean

timezoneId

null | string

days

Array<object> | null

object

formattedDay

null | string

formattedDateTime

null | string

friendlyDate

null | string

extendedLocation

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

code

null | string

name

null | string

description

null | string

externalUrl

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

locationKind

Allowed values: None Place City Hotel ConventionCenter Building Room Table Booth Other

capacity

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

publish

boolean

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

timezone

null | string

coordinates

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

cost

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

currency

null | string

useForAllEventTypes

boolean

contactInformation

null | string

createdByUserId

string format: uuid

creatorIsOwner

boolean

hasRate

boolean

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

recurrence

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

recurrenceRule

null | string

exclusionRecurrenceRule

null | string

exclusionRecurrenceDate

null | string format: date-time

startDate

null | string format: date-time

endDate

null | string format: date-time

endKind

Allowed values: Never AfterNTimes Date

intervalKind

Allowed values: Never Daily Weekly Monthly Yearly

numberOfRecurrencesToEnd

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dailyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

weeklyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

montlyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monthlyRepeatKind

Allowed values: Never DayOfMonth DayOfNthWeek

monthlyDOWInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monthlyWeekInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyRepeatKind

Allowed values: Never DayOfYear DayOfNthWeekAndDayAndMonth

yearlyDOWInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyWeekInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyMonthInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyMonth

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyDay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dayOfMonth

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

sunday

boolean

monday

boolean

tuesday

boolean

wednesday

boolean

thursday

boolean

friday

boolean

saturday

boolean

categories

Array<object> | null

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

displayOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

code

null | string

name

null | string

description

null | string

categoryKind

Allowed values: Multi Single Tags

useForAllEventTypes

boolean

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

publish

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

descriptor

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasChecklist

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

dti

object

start

null | string format: date-time

end

null | string format: date-time

isUtc

boolean

hasStartTime

boolean

hasEndTime

boolean

formattedStartTime

null | string

formattedEndTime

null | string

formattedTime

null | string

friendlyTimespan

null | string

formattedDay

null | string

formattedDayCompact

null | string

formattedDateTime

null | string

friendlyDate

null | string

timezone

object

id

null | string

hasIanaId

boolean

displayName

null | string

standardName

null | string

daylightName

null | string

baseUtcOffset

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

supportsDaylightSavingTime

boolean

timezoneId

null | string

days

Array<object> | null

object

formattedDay

null | string

formattedDateTime

null | string

friendlyDate

null | string

locationIds

Array<string> | null

facilitators

Array<object> | null

object

facilitator

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

name

null | string

firstName

null | string

lastName

null | string

email

null | string

contactEmail

null | string

description

null | string

url

null | string

phone

null | string

contactInformation

null | string

jobTitle

null | string

company

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

tags

null | string

externalId

null | string

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

descriptors

null | string

facilitatorKind

Allowed values: Person Company Other

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

rank

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

itemOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

facilitatorTypes

Array<object> | null

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

useForAllEventTypes

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasRate

boolean

hasMetaFields

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

rank

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

virtualInfo

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

url

null | string

externalId

null | string

externalResourceType

null | string

extraInfo

null | string

publish

boolean

openDate

null | string format: date-time

closeDate

null | string format: date-time

displayMinsAfterStart

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

numMinsToDisplay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

meta

null | object

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

streamServer

null | string

streamKey

null | string

securityType

null | string

iframeEnabled

boolean

textChatEnabled

boolean

reactionsEnabled

boolean

videoChatEnabled

boolean

audioChatEnabled

boolean

liveStreamEnabled

boolean

consumerAppId

null | string format: uuid

onDemandEnabled

boolean

onDemandUrl

null | string

livestreamUrl

null | string

externalMeetingUrl

null | string

externalEmbed

null | string

meetingSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

kind

One of:

null

null

integer

integer

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

createdByUserId

string format: uuid

modifiedByUserId

null | string format: uuid

organizationId

null | string format: uuid

projectId

string format: uuid

baseType

Allowed values: Public Invitation Ticketed Registration Private Basic

eventTypeId

null | string format: uuid

eventSettingsId

null | string format: uuid

eventSettingsOverride

boolean

locationId

null | string format: uuid

timeslotId

null | string format: uuid

name

null | string

code

null | string

eid

null | string

location

null | string

description

null | string

notes

null | string

descriptionHtml

null | string

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

timezone

null | string

url

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

iCalUID

null | string

importedCalendarId

null | string

expectedAttendance

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

actualAttendance

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasWaitlist

boolean

waitlistSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maximumEventSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isDeclined

boolean

hasReminder

boolean

useDefaultReminder

boolean

reminderMins

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

status

Allowed values: Tentative Confirmed Cancelled

approvalStatus

Allowed values: Proposed Approved Declined UnderReview

visibility

Allowed values: Default Public Private Confidential

transparency

Allowed values: Opaque Transparent

durationMilliseconds

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationMinutes

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationHours

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationSeconds

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

start

null | string format: date-time

startTimezone

null | string

hasStartTime

boolean

end

null | string format: date-time

endTimezone

null | string

hasEndTime

boolean

startUtc

null | string format: date-time

endUtc

null | string format: date-time

utcOffset

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isAllDay

boolean

isMultiDay

boolean

isLocked

boolean

isRecurring

boolean

recurrenceId

null | string format: uuid

recursUntil

null | string format: date-time

recurrencePattern

null | string

organizerId

null | string format: uuid

creatorIsOrganizer

boolean

priority

Allowed values: Default Low High

sequence

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

socials

null | string

price

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

currency

null | string

publish

boolean

forceSchedule

boolean

isVirtual

boolean

customUrl

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

hEventDescriptorId

null | string format: uuid

isExpired

boolean

numberOfComments

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

reactionSummary

null | string

slug

null | string

locationData

null | string

externalId

null | string

category

null | string

hasChecklist

boolean

checkedInDate

null | string format: date-time

isDraft

null | boolean

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

organizer

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

name

null | string

firstName

null | string

lastName

null | string

email

null | string

contactEmail

null | string

phone

null | string

jobTitle

null | string

company

null | string

description

null | string

url

null | string

contactInformation

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

type

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

organizationId

null | string format: uuid

projectId

string format: uuid

name

null | string

code

null | string

description

null | string

baseType

Allowed values: Public Invitation Ticketed Registration Private Basic

eventSettingsId

null | string format: uuid

hasChecklist

boolean

hasMetaFields

boolean

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

publish

boolean

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

isLocked

boolean

isSubEventType

boolean

subEventLabel

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

timeslot

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

name

null | string

description

null | string

timeslotType

Allowed values: Timeslot Availability Exclusion

publish

boolean

start

null | string format: date-time

startTime

null | string

hasStartTime

boolean

end

null | string format: date-time

endTime

null | string

hasEndTime

boolean

startUtc

null | string format: date-time

endUtc

null | string format: date-time

timezone

null | string

startTimezone

null | string

endTimezone

null | string

isAllDay

boolean

isRecurring

boolean

recurrencePattern

null | string

intervalSeconds

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

useForAllEventTypes

boolean

daysOfWeek

One of:

null

null

string

string

tags

null | string

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

dti

object

start

null | string format: date-time

end

null | string format: date-time

isUtc

boolean

hasStartTime

boolean

hasEndTime

boolean

formattedStartTime

null | string

formattedEndTime

null | string

formattedTime

null | string

friendlyTimespan

null | string

formattedDay

null | string

formattedDayCompact

null | string

formattedDateTime

null | string

friendlyDate

null | string

timezone

object

id

null | string

hasIanaId

boolean

displayName

null | string

standardName

null | string

daylightName

null | string

baseUtcOffset

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

supportsDaylightSavingTime

boolean

timezoneId

null | string

days

Array<object> | null

object

formattedDay

null | string

formattedDateTime

null | string

friendlyDate

null | string

extendedLocation

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

code

null | string

name

null | string

description

null | string

externalUrl

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

locationKind

Allowed values: None Place City Hotel ConventionCenter Building Room Table Booth Other

capacity

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

publish

boolean

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

timezone

null | string

coordinates

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

cost

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

currency

null | string

useForAllEventTypes

boolean

contactInformation

null | string

createdByUserId

string format: uuid

creatorIsOwner

boolean

hasRate

boolean

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

recurrence

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

recurrenceRule

null | string

exclusionRecurrenceRule

null | string

exclusionRecurrenceDate

null | string format: date-time

startDate

null | string format: date-time

endDate

null | string format: date-time

endKind

Allowed values: Never AfterNTimes Date

intervalKind

Allowed values: Never Daily Weekly Monthly Yearly

numberOfRecurrencesToEnd

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dailyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

weeklyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

montlyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monthlyRepeatKind

Allowed values: Never DayOfMonth DayOfNthWeek

monthlyDOWInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monthlyWeekInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyRepeatKind

Allowed values: Never DayOfYear DayOfNthWeekAndDayAndMonth

yearlyDOWInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyWeekInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyMonthInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyMonth

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyDay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dayOfMonth

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

sunday

boolean

monday

boolean

tuesday

boolean

wednesday

boolean

thursday

boolean

friday

boolean

saturday

boolean

categories

Array<object> | null

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

displayOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

code

null | string

name

null | string

description

null | string

categoryKind

Allowed values: Multi Single Tags

useForAllEventTypes

boolean

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

publish

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

descriptor

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasChecklist

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

dti

object

start

null | string format: date-time

end

null | string format: date-time

isUtc

boolean

hasStartTime

boolean

hasEndTime

boolean

formattedStartTime

null | string

formattedEndTime

null | string

formattedTime

null | string

friendlyTimespan

null | string

formattedDay

null | string

formattedDayCompact

null | string

formattedDateTime

null | string

friendlyDate

null | string

timezone

object

id

null | string

hasIanaId

boolean

displayName

null | string

standardName

null | string

daylightName

null | string

baseUtcOffset

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

supportsDaylightSavingTime

boolean

timezoneId

null | string

days

Array<object> | null

object

formattedDay

null | string

formattedDateTime

null | string

friendlyDate

null | string

locationIds

Array<string> | null

facilitators

Array<object> | null

object

facilitator

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

name

null | string

firstName

null | string

lastName

null | string

email

null | string

contactEmail

null | string

description

null | string

url

null | string

phone

null | string

contactInformation

null | string

jobTitle

null | string

company

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

tags

null | string

externalId

null | string

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

descriptors

null | string

facilitatorKind

Allowed values: Person Company Other

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

rank

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

itemOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

facilitatorTypes

Array<object> | null

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

useForAllEventTypes

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasRate

boolean

hasMetaFields

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

rank

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

virtualInfo

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

url

null | string

externalId

null | string

externalResourceType

null | string

extraInfo

null | string

publish

boolean

openDate

null | string format: date-time

closeDate

null | string format: date-time

displayMinsAfterStart

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

numMinsToDisplay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

meta

null | object

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

streamServer

null | string

streamKey

null | string

securityType

null | string

iframeEnabled

boolean

textChatEnabled

boolean

reactionsEnabled

boolean

videoChatEnabled

boolean

audioChatEnabled

boolean

liveStreamEnabled

boolean

consumerAppId

null | string format: uuid

onDemandEnabled

boolean

onDemandUrl

null | string

livestreamUrl

null | string

externalMeetingUrl

null | string

externalEmbed

null | string

meetingSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

kind

One of:

null

null

integer

integer

Example

{
  "baseType": "Public",
  "status": "Tentative",
  "approvalStatus": "Proposed",
  "visibility": "Default",
  "transparency": "Opaque",
  "priority": "Default",
  "type": {
    "baseType": "Public"
  },
  "timeslot": {
    "timeslotType": "Timeslot"
  },
  "extendedLocation": {
    "locationKind": "None"
  },
  "recurrence": {
    "endKind": "Never",
    "intervalKind": "Never",
    "monthlyRepeatKind": "Never",
    "yearlyRepeatKind": "Never"
  },
  "categories": [
    {
      "categoryKind": "Multi"
    }
  ],
  "facilitators": [
    {
      "facilitator": {
        "facilitatorKind": "Person"
      }
    }
  ]
}

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

createdByUserId

string format: uuid

modifiedByUserId

null | string format: uuid

organizationId

null | string format: uuid

projectId

string format: uuid

baseType

Allowed values: Public Invitation Ticketed Registration Private Basic

eventTypeId

null | string format: uuid

eventSettingsId

null | string format: uuid

eventSettingsOverride

boolean

locationId

null | string format: uuid

timeslotId

null | string format: uuid

name

null | string

code

null | string

eid

null | string

location

null | string

description

null | string

notes

null | string

descriptionHtml

null | string

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

timezone

null | string

url

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

iCalUID

null | string

importedCalendarId

null | string

expectedAttendance

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

actualAttendance

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasWaitlist

boolean

waitlistSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maximumEventSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isDeclined

boolean

hasReminder

boolean

useDefaultReminder

boolean

reminderMins

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

status

Allowed values: Tentative Confirmed Cancelled

approvalStatus

Allowed values: Proposed Approved Declined UnderReview

visibility

Allowed values: Default Public Private Confidential

transparency

Allowed values: Opaque Transparent

durationMilliseconds

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationMinutes

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationHours

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

durationSeconds

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

start

null | string format: date-time

startTimezone

null | string

hasStartTime

boolean

end

null | string format: date-time

endTimezone

null | string

hasEndTime

boolean

startUtc

null | string format: date-time

endUtc

null | string format: date-time

utcOffset

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isAllDay

boolean

isMultiDay

boolean

isLocked

boolean

isRecurring

boolean

recurrenceId

null | string format: uuid

recursUntil

null | string format: date-time

recurrencePattern

null | string

organizerId

null | string format: uuid

creatorIsOrganizer

boolean

priority

Allowed values: Default Low High

sequence

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

socials

null | string

price

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

currency

null | string

publish

boolean

forceSchedule

boolean

isVirtual

boolean

customUrl

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

hEventDescriptorId

null | string format: uuid

isExpired

boolean

numberOfComments

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

reactionSummary

null | string

slug

null | string

locationData

null | string

externalId

null | string

category

null | string

hasChecklist

boolean

checkedInDate

null | string format: date-time

isDraft

null | boolean

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

organizer

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

name

null | string

firstName

null | string

lastName

null | string

email

null | string

contactEmail

null | string

phone

null | string

jobTitle

null | string

company

null | string

description

null | string

url

null | string

contactInformation

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

type

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

organizationId

null | string format: uuid

projectId

string format: uuid

name

null | string

code

null | string

description

null | string

baseType

Allowed values: Public Invitation Ticketed Registration Private Basic

eventSettingsId

null | string format: uuid

hasChecklist

boolean

hasMetaFields

boolean

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

publish

boolean

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

isLocked

boolean

isSubEventType

boolean

subEventLabel

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

timeslot

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

name

null | string

description

null | string

timeslotType

Allowed values: Timeslot Availability Exclusion

publish

boolean

start

null | string format: date-time

startTime

null | string

hasStartTime

boolean

end

null | string format: date-time

endTime

null | string

hasEndTime

boolean

startUtc

null | string format: date-time

endUtc

null | string format: date-time

timezone

null | string

startTimezone

null | string

endTimezone

null | string

isAllDay

boolean

isRecurring

boolean

recurrencePattern

null | string

intervalSeconds

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

useForAllEventTypes

boolean

daysOfWeek

One of:

null

null

string

string

tags

null | string

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

dti

object

start

null | string format: date-time

end

null | string format: date-time

isUtc

boolean

hasStartTime

boolean

hasEndTime

boolean

formattedStartTime

null | string

formattedEndTime

null | string

formattedTime

null | string

friendlyTimespan

null | string

formattedDay

null | string

formattedDayCompact

null | string

formattedDateTime

null | string

friendlyDate

null | string

timezone

object

id

null | string

hasIanaId

boolean

displayName

null | string

standardName

null | string

daylightName

null | string

baseUtcOffset

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

supportsDaylightSavingTime

boolean

timezoneId

null | string

days

Array<object> | null

object

formattedDay

null | string

formattedDateTime

null | string

friendlyDate

null | string

extendedLocation

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

code

null | string

name

null | string

description

null | string

externalUrl

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

locationKind

Allowed values: None Place City Hotel ConventionCenter Building Room Table Booth Other

capacity

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

publish

boolean

latitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

longitude

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

timezone

null | string

coordinates

null | string

address1

null | string

address2

null | string

city

null | string

state

null | string

country

null | string

postalCode

null | string

cost

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

currency

null | string

useForAllEventTypes

boolean

contactInformation

null | string

createdByUserId

string format: uuid

creatorIsOwner

boolean

hasRate

boolean

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

recurrence

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

recurrenceRule

null | string

exclusionRecurrenceRule

null | string

exclusionRecurrenceDate

null | string format: date-time

startDate

null | string format: date-time

endDate

null | string format: date-time

endKind

Allowed values: Never AfterNTimes Date

intervalKind

Allowed values: Never Daily Weekly Monthly Yearly

numberOfRecurrencesToEnd

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dailyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

weeklyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

montlyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyIntervalRepeatNumber

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monthlyRepeatKind

Allowed values: Never DayOfMonth DayOfNthWeek

monthlyDOWInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

monthlyWeekInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyRepeatKind

Allowed values: Never DayOfYear DayOfNthWeekAndDayAndMonth

yearlyDOWInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyWeekInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyMonthInterval

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyMonth

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

yearlyDay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dayOfMonth

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

sunday

boolean

monday

boolean

tuesday

boolean

wednesday

boolean

thursday

boolean

friday

boolean

saturday

boolean

categories

Array<object> | null

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

parentId

null | string format: uuid

topLevelId

string format: uuid

currentLevel

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

displayOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

code

null | string

name

null | string

description

null | string

categoryKind

Allowed values: Multi Single Tags

useForAllEventTypes

boolean

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

publish

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

descriptor

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasChecklist

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

dti

object

start

null | string format: date-time

end

null | string format: date-time

isUtc

boolean

hasStartTime

boolean

hasEndTime

boolean

formattedStartTime

null | string

formattedEndTime

null | string

formattedTime

null | string

friendlyTimespan

null | string

formattedDay

null | string

formattedDayCompact

null | string

formattedDateTime

null | string

friendlyDate

null | string

timezone

object

id

null | string

hasIanaId

boolean

displayName

null | string

standardName

null | string

daylightName

null | string

baseUtcOffset

string

/^-?(\d+\.)?\d{2}:\d{2}:\d{2}(\.\d{1,7})?$/

supportsDaylightSavingTime

boolean

timezoneId

null | string

days

Array<object> | null

object

formattedDay

null | string

formattedDateTime

null | string

friendlyDate

null | string

locationIds

Array<string> | null

facilitators

Array<object> | null

object

facilitator

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

userId

null | string format: uuid

personId

null | string format: uuid

name

null | string

firstName

null | string

lastName

null | string

email

null | string

contactEmail

null | string

description

null | string

url

null | string

phone

null | string

contactInformation

null | string

jobTitle

null | string

company

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

tags

null | string

externalId

null | string

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

descriptors

null | string

facilitatorKind

Allowed values: Person Company Other

meta

null | object

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

rank

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

itemOrder

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

facilitatorTypes

Array<object> | null

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

publish

boolean

useForAllEventTypes

boolean

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

imageUrl

null | string

imageAssetId

null | string format: uuid

itemOrder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

hasRate

boolean

hasMetaFields

boolean

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

rank

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

virtualInfo

object

id

string format: uuid

created

string format: date-time

modified

string format: date-time

etag

null | string

projectId

string format: uuid

eventId

string format: uuid

organizationId

null | string format: uuid

name

null | string

description

null | string

url

null | string

externalId

null | string

externalResourceType

null | string

extraInfo

null | string

publish

boolean

openDate

null | string format: date-time

closeDate

null | string format: date-time

displayMinsAfterStart

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

numMinsToDisplay

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

meta

null | object

imageUrl

null | string

imageAssetId

null | string format: uuid

style

object

hasStyle

boolean

primaryColor

null | string

secondaryColor

null | string

backgroundColor

null | string

textColor

null | string

contrastColor

null | string

fontFamily

null | string

secondaryContrastColor

null | string

profileImages

object

defaultOriginal

null | string

defaultLarge

null | string

defaultMedium

null | string

defaultSmall

null | string

thumbnailSmall

null | string

thumbnailLarge

null | string

streamServer

null | string

streamKey

null | string

securityType

null | string

iframeEnabled

boolean

textChatEnabled

boolean

reactionsEnabled

boolean

videoChatEnabled

boolean

audioChatEnabled

boolean

liveStreamEnabled

boolean

consumerAppId

null | string format: uuid

onDemandEnabled

boolean

onDemandUrl

null | string

livestreamUrl

null | string

externalMeetingUrl

null | string

externalEmbed

null | string

meetingSize

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

kind

One of:

null

null

integer

integer

Example

{
  "baseType": "Public",
  "status": "Tentative",
  "approvalStatus": "Proposed",
  "visibility": "Default",
  "transparency": "Opaque",
  "priority": "Default",
  "type": {
    "baseType": "Public"
  },
  "timeslot": {
    "timeslotType": "Timeslot"
  },
  "extendedLocation": {
    "locationKind": "None"
  },
  "recurrence": {
    "endKind": "Never",
    "intervalKind": "Never",
    "monthlyRepeatKind": "Never",
    "yearlyRepeatKind": "Never"
  },
  "categories": [
    {
      "categoryKind": "Multi"
    }
  ],
  "facilitators": [
    {
      "facilitator": {
        "facilitatorKind": "Person"
      }
    }
  ]
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}