Get events

GET /api/2.0/community/event

Request

Returns a list of all the portal events with the event titles, dates of creation and update, event texts, and authors.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Examples

GET /api/2.0/community/event HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/community/event \
  --header 'Accept: application/json'

Responses

200

List of events

Idstring
Uidstring
CalendarIdstring
Namestring
Descriptionstring
AllDayLongboolean
Startstring
Endstring
RepeatRulestring
Alertobject
Typeintegerformat: int32
IsSharedboolean
CanUnsubscribeboolean
IsEditableboolean
Permissionsobject
UserParamsarray of object
Idstringformat: uuid
Namestring
Ownerobject
Idstringformat: uuid
Namestring
Statusenum of integerformat: int32

[0 - Tentative, 1 - Confirmed, 2 - Cancelled]

Can be one of: Tentative, Confirmed, Cancelled.

HasAttachmentsboolean

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).