Skip to content
EventPoint Developer Documentation

Query events

POST
/api/events/query
curl --request POST \
  --url https://api.eventpoint.io/api/events/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "page": 1, "itemsPerPage": 1, "sort": "example", "sortDir": "Asc", "terms": "example", "projects": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "organizations": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "topLevelOnly": true, "parentEventsOnly": true, "topLevelIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "parentIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "attendeePersonIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "excludeDisabledScheduling": true, "includeDisabledSchedulingForAttendeePersonId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "eventIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "eventTypes": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "excludeEventTypes": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "requiredCategories": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "categories": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "locations": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "organizers": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "timeslots": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "facilitators": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "companyMembers": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "companies": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "startUtc": "2026-04-15T12:00:00Z", "endUtc": "2026-04-15T12:00:00Z", "publish": true, "isDraft": true, "approvalStatus": "Proposed", "unscheduled": true, "noLocation": true, "includeAllDays": true, "hasAssets": true, "hasAssetTypeIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "hasOnDemand": true, "hasLivestream": true, "prepEvents": true, "timePeriodFilter": "All", "useSearchService": true, "overlappingTimes": true, "aiResult": true }'

Queries events by organization, project, top-level event, or parent event. At least one scope must be provided (project, toplevel id, or parentid).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

The request details.

object
page
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
itemsPerPage
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
sort
null | string
sortDir
One of:
null
terms
null | string
projects
Array<string> | null
organizations
Array<string> | null
topLevelOnly
boolean
parentEventsOnly
boolean
topLevelIds
Array<string> | null
parentIds
Array<string> | null
attendeePersonIds
Array<string> | null
excludeDisabledScheduling
boolean
includeDisabledSchedulingForAttendeePersonId
null | string format: uuid
eventIds
Array<string> | null
eventTypes
Array<string> | null
excludeEventTypes
Array<string> | null
requiredCategories
Array<string> | null
categories
Array<string> | null
locations
Array<string> | null
organizers
Array<string> | null
timeslots
Array<string> | null
facilitators
Array<string> | null
companyMembers
Array<string> | null
companies
Array<string> | null
startUtc
null | string format: date-time
endUtc
null | string format: date-time
publish
null | boolean
isDraft
null | boolean
approvalStatus
One of:
null
unscheduled
null | boolean
noLocation
null | boolean
includeAllDays
null | boolean
hasAssets
null | boolean
hasAssetTypeIds
Array<string> | null
hasOnDemand
null | boolean
hasLivestream
null | boolean
prepEvents
boolean
timePeriodFilter
Allowed values: All Upcoming Past
useSearchService
boolean
overlappingTimes
boolean
aiResult
boolean

Responses

Section titled “Responses”

200

Section titled “200”

OK

object
page
null | integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
itemsPerPage
null | integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
continuationToken
null | string
cacheToken
null | string
count
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
numberOfPages
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
data
Array<object> | null
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
disableScheduling
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
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
streamProvider
null | string
liveSourceType
null | string
onDemandSourceType
null | string
providerInputId
null | string
providerRecordingId
null | string
autoPublishRecording
boolean
onDemandPublishAt
null | string format: date-time
reactionEmojis
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
sort
null | string
sortDir
One of:
null
request
object
page
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
itemsPerPage
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
continuationToken
null | string
sort
null | string
sortDir
One of:
null
terms
null | string
categories
Array<string> | null
dateLow
null | string format: date-time
dateHigh
null | string format: date-time

403

Section titled “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