Skip to main content
GET
Count events

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

originType
enum<string>
default:community

Origin type of the event

  • community - Event created in a community
  • user - Event created on a user profile
Available options:
community,
user
originId
string

ID of the origin (community ID, or user ID when originType is user)

userId
string

Filter events by creator user ID (admin only or the user themselves)

excludeOwnEvents
boolean
default:false

Exclude events created by the calling user

status
enum<string>

Event status. When omitted, non-admin callers default to scheduled; admin callers get every status.

  • scheduled - Event is scheduled
  • live - Event is currently live
  • ended - Event has ended
  • cancelled - Event is cancelled
Available options:
scheduled,
live,
ended,
cancelled
type
enum<string>

Filter events by type

Available options:
virtual,
in_person
tags
string[]

Event tags for categorization

Maximum array length: 5
Maximum string length: 100
startTimeGte
string<date-time>

Filter events with start time greater than or equal to this value

startTimeLte
string<date-time>

Filter events with start time less than or equal to this value

Response

Event count retrieved successfully

count
integer
Example:

42