Skip to navigation

List Events

List the events in your organization. Archived ones are left out.

Authentication

AuthorizationBearer

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

Query parameters

statusenumOptional

As returned: LIVE is everything scheduled or live, and ENDED takes in an event whose last window has closed.

Allowed values:
phaseenumOptional

Where the event stands right now, from its times first: it opens at the earlier of startsAt and questionsOpenAt, and ends at the later of endsAt and questionsCloseAt, with nobody having to start it.

Allowed values:
qstringOptional

Search events by their title, join code and description. Every word must appear in one of those fields; case and accents are ignored; at most 100 characters and 8 words. See Searching under Errors and pagination.

searchstringOptionalDeprecated

The older name for q, matched the same way. Deprecated; q wins when both are sent.

archivedbooleanOptional
minebooleanOptional

The console’s My events: only those the person created, and those whose host list names them or a team they are on. For a key, its maker’s; 403 forbidden once the maker has left the workspace.

limitintegerOptional
cursorstringOptional

Response

This endpoint returns an object.
datalist of objects
hasMoreboolean
nextCursorstringOptional

Errors

401
Unauthorized Error
402
Subscription Required Error
403
Forbidden Error
429
Too Many Requests Error