Docs
Get Events
GET /Organizations/{organizationId}/events
GET
/Organizations/{organizationId}/eventsRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Returns all events that belong to the organization, plus any personal events owned by the authenticated user. Each event includes its custom attribute values and the authenticated user's collaborator reference (if they are a collaborator on that event).
Requires OrganizationBasicAccess permission.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| organizationId | Guid | Required | The organization to list events for. |
Response
Returns an array of events.
| Field | Type | Description |
|---|---|---|
| id | Guid | Unique event ID. |
| name | string | Event name. |
| isArchived | bool | Whether the event is archived. |
| organization | Organization | The organization this event belongs to. |
| attributes | Attribute[] | Custom attribute values set on the event. |
| collaborator | CollaboratorRef| null | The authenticated user's collaborator on this event, or `null`. |
Organization
| Field | Type | Description |
|---|---|---|
| id | Guid | Organization ID. |
| name | string | Organization display name. |
Attribute
| Field | Type | Description |
|---|---|---|
| attributeId | Guid | The attribute definition ID. |
| value | string | The value set for this event. |
CollaboratorRef
| Field | Type | Description |
|---|---|---|
| id | Guid | Collaborator ID. |
| name | string | Collaborator display name. |