Skip to content
Cohost API

List events for the authenticated context

GET
/events

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
string

Comma-separated list of statuses to filter by (e.g. live,started)

orderBy
string
Allowed values: start end name

Field to order results by (start, end, or name)

order
string
Allowed values: asc desc

Sort direction

mode
string
Allowed values: edit profile

Response mode - edit returns full Event objects, profile returns EventProfile objects

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A list of events or event profiles

object
status
required
string
Allowed values: ok
data
required
Array
One of:

Placeholder schema for Event. Add it to the schemaMap in scripts/create-content/api-docs.mjs for a richer definition.

object

401

Section titled “401 ”

Unauthorized

object
status
string
Example
error
message
string
Example
An error occurred
error
string

500

Section titled “500 ”

Internal server error

object
status
string
Example
error
message
string
Example
An error occurred
error
string