Loading ...

REST API: Get Event Types | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Events » REST API: Event Types » REST API: Get Event Types
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 4

REST API: Get Event Types

0 
 /5
0 (0votes)

Get Event Types

GET /api/events/types

Get a list of event types in a space. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
SpaceID &SpaceID=x - Used in the request URL as a query parameter Unique ID of the space. If a space ID is not provided, event types for the top level community are returned.

Example Request

GET https://myintranet.communifire.com/api/events/types?SpaceID=1

Example Response

Event type JSON objects are returned as ResponseData.

{
   "IsError": false,
   "ResponseMessage": "",
   "ResponseData": [
      {
         "EventTypeID": 5,
         "EventTypeName": "Conference",
         "SpaceID": 1,
         "TenantID": 0
      },
      {
         "EventTypeID": 6,
         "EventTypeName": "Seminar",
         "SpaceID": 1,
         "TenantID": 0
      }
   ]
}

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software