events

For users and admins: the events routes cover this part of the API. Every route lives under the one public origin, https://venturenetwork.ai, and answers errors as problem types. The interactive version of this page is the live Scalar reference at https://venturenetwork.ai/docs. This page is generated from packages/sdk/openapi.json on every build.

GET /v1/events

Operation id EventsController_list.

Parameters

Name	In	Required	Type	Notes
limit	query	no	integer
cursor	query	no	string
mine	query	no	boolean	Only events you host or have RSVPd to.
when	query	no	string, one of upcoming, past

Responses

200

Field	Type	Required	Notes
items	array of object	yes
nextCursor	string or null	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.

POST /v1/events

Operation id EventsController_create.

Request body

Field	Type	Required	Notes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000, default ""
startsAt	string (date-time)	yes
endsAt	string (date-time)	yes
timezone	string	yes	max length 64, default "America/New_York"
locationKind	string, one of in_person, virtual, hybrid	yes	default "in_person"
location	string	yes	max length 200, default ""
joinUrl	`` or string (uri)	yes	default ""
capacity	integer or null	yes	default null
scope	string, one of public, org_members	yes	default "public"
publish	boolean	yes	default false

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.

GET /v1/events/{id}

Operation id EventsController_read.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.

PATCH /v1/events/{id}

Operation id EventsController_update.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string

Request body

Field	Type	Required	Notes
title	string	no	min length 3, max length 140
description	string	no	max length 4000
startsAt	string (date-time)	no
endsAt	string (date-time)	no
timezone	string	no	max length 64
locationKind	string, one of in_person, virtual, hybrid	no
location	string	no	max length 200
joinUrl	`` or string (uri)	no
capacity	integer or null	no
scope	string, one of public, org_members	no

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.

POST /v1/events/{id}/cancel

Operation id EventsController_cancel.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.

PUT /v1/events/{id}/cover

Operation id EventsController_setCover.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.

DELETE /v1/events/{id}/cover

Operation id EventsController_removeCover.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.

PUT /v1/events/{id}/cover/from-url

Operation id EventsController_setCoverFromUrl.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string

Request body

Field	Type	Required	Notes
url	string (uri)	yes	max length 2000

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.

POST /v1/events/{id}/publish

Operation id EventsController_publish.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended.

PUT /v1/events/{id}/rsvp

Operation id EventsController_rsvp.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string

Request body

Field	Type	Required	Notes
status	string, one of going, cancelled	yes

Responses

200

Field	Type	Required	Notes
status	string, one of going, waitlist, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, validation_failed.

GET /v1/events/{id}/rsvps

Operation id EventsController_rsvps.

Parameters

Name	In	Required	Type	Notes
id	path	yes	string
limit	query	no	integer
cursor	query	no	string

Responses

200

Field	Type	Required	Notes
items	array of object	yes
nextCursor	string or null	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): invalid_cursor, membership_pending, membership_suspended, validation_failed.

GET /v1/orgs/{slug}/events

Operation id OrgEventsController_list.

Parameters

Name	In	Required	Type	Notes
limit	query	no	integer
cursor	query	no	string
when	query	no	string, one of upcoming, past
slug	path	yes	string

Responses

200

Field	Type	Required	Notes
items	array of object	yes
nextCursor	string or null	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found, validation_failed.

POST /v1/orgs/{slug}/events

Operation id OrgEventsController_create.

Parameters

Name	In	Required	Type	Notes
slug	path	yes	string

Request body

Field	Type	Required	Notes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000, default ""
startsAt	string (date-time)	yes
endsAt	string (date-time)	yes
timezone	string	yes	max length 64, default "America/New_York"
locationKind	string, one of in_person, virtual, hybrid	yes	default "in_person"
location	string	yes	max length 200, default ""
joinUrl	`` or string (uri)	yes	default ""
capacity	integer or null	yes	default null
scope	string, one of public, org_members	yes	default "public"
publish	boolean	yes	default false

Responses

200

Field	Type	Required	Notes
id	string	yes
hostOrgSlug	string or null	yes
hostOrgName	string or null	yes
hostUserId	string	yes
hostHandle	string or null	yes
hostName	string	yes
title	string	yes	min length 3, max length 140
description	string	yes	max length 4000
startsAt	string	yes
endsAt	string	yes
timezone	string	yes
locationKind	string, one of in_person, virtual, hybrid	yes
location	string	yes	max length 200
joinUrl	string or null	yes
coverImage	string or null	yes
capacity	integer or null	yes
scope	string, one of public, org_members	yes
status	string, one of draft, published, cancelled	yes
goingCount	integer	yes
waitlistCount	integer	yes
myRsvpStatus	string, one of going, waitlist, cancelled or null	yes
canManage	boolean	yes
createdAt	string	yes
updatedAt	string	yes

Problem types

Derived from the source scan (handler, one level of service calls, guards and pipes): membership_pending, membership_suspended, org_not_found, org_role_required, validation_failed.