Type Alias: GatheringResponse
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Gathering ID |
projectId | string | Yes | Project ID |
tenantId | string | Yes | Tenant ID |
name | string | Yes | Gathering name |
description | string | No | Gathering description |
inviterName | string | No | Display name of the gathering organizer |
inviterEmail | string | No | Email address of the gathering organizer (used as Reply-To in invitation emails) |
type | "lobby" | "appointment" | "open" | Yes | Gathering type |
status | "pending" | "active" | "started" | "ended" | "cancelled" | "expired" | Yes | Gathering status |
maxMembers | number | Yes | Maximum members allowed |
memberCount | number | Yes | Current member count |
accessPolicy | string | Yes | Access policy |
listed | boolean | Yes | Whether gathering is listed for discovery |
startsAt | string | No | Scheduled start time |
endsAt | string | No | Scheduled end time |
timezone | string | No | Timezone for scheduled times |
roomId | string | No | Target ODIN room ID |
autoStartSession | boolean | Yes | Whether session starts automatically |
sessionId | string | No | Created session ID |
joinCode | string | Yes | Join code for sharing |
properties | object | No | Custom properties |
ownerId | string | No | Owner participant ID |
createdAt | string | Yes | Creation timestamp |
expiresAt | string | No | Expiration timestamp |
members | GatheringMember[] | No | Members (included in detailed view) |
Defined in
4Players/cortex-typescript-sdk/src/resources/gatherings.ts:21