GET api/Events
Gets a list of events
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of Tools_Events| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | integer |
None. |
|
| SiteID | integer |
None. |
|
| PageID | integer |
None. |
|
| LocationID | integer |
None. |
|
| ClassID | integer |
None. |
|
| EventTypeID | integer |
None. |
|
| EventScheduleID | integer |
None. |
|
| StartDateTime | date |
None. |
|
| EndDateTime | date |
None. |
|
| TimeZone | string |
None. |
|
| RecurScheme | integer |
None. |
|
| Recurrence | integer |
None. |
|
| RecurDayOfMonth | integer |
None. |
|
| RecurMonthWeek | integer |
None. |
|
| RecurMonthWeekDay | integer |
None. |
|
| RecurTimeout | date |
None. |
|
| RecurIntervals | integer |
None. |
|
| MonStartTime | string |
None. |
|
| MonEndTime | string |
None. |
|
| TueStartTime | string |
None. |
|
| TueEndTime | string |
None. |
|
| WedStartTime | string |
None. |
|
| WedEndTime | string |
None. |
|
| ThuStartTime | string |
None. |
|
| ThuEndTime | string |
None. |
|
| FriStartTime | string |
None. |
|
| FriEndTime | string |
None. |
|
| SatStartTime | string |
None. |
|
| SatEndTime | string |
None. |
|
| SunStartTime | string |
None. |
|
| SunEndTime | string |
None. |
|
| Title | string |
None. |
|
| NameKey | string |
None. |
|
| Description | string |
None. |
|
| Summary | string |
None. |
|
| PDFAgenda | string |
None. |
|
| PDFTools | string |
None. |
|
| PDFText | string |
None. |
|
| SendCheckIn | boolean |
None. |
|
| CheckInMessage | string |
None. |
|
| PromoInstruct | string |
None. |
|
| TicketsAvailable | string |
None. |
|
| ContactName | string |
None. |
|
| ContactPhone | string |
None. |
|
| ContactEmail | string |
None. |
|
| InfoURL | string |
None. |
|
| FormAttachID | integer |
None. |
|
| BCCEmails | string |
None. |
|
| CustomHeaderID | integer |
None. |
|
| CustomLogoID | integer |
None. |
|
| CustomPDFImageID | integer |
None. |
|
| CostCenterID | integer |
None. |
|
| BrandID | integer |
None. |
|
| BrandName | string |
None. |
|
| Artist | string |
None. |
|
| Price | string |
None. |
|
| MaxTickets | string |
None. |
|
| Points | string |
None. |
|
| Brand | string |
None. |
|
| Active | boolean |
None. |
|
| SortPriority | decimal number |
None. |
|
| CreatedDate | date |
None. |
|
| LastUpdatedDate | date |
None. |
|
| CreatedBy | integer |
None. |
|
| UpdatedBy | integer |
None. |
|
| CancelledDate | date |
None. |
|
| CancelledBy | integer |
None. |
|
| CountryCd | integer |
None. |
|
| IsVoucher | boolean |
None. |
|
| IsCustom | boolean |
None. |
|
| HideTime | boolean |
None. |
|
| HideMap | boolean |
None. |
|
| FollowUpSent | boolean |
None. |
|
| FollowUpSentDate | date |
None. |
|
| FollowUpSurveyID | integer |
None. |
|
| NonCompleted | boolean |
None. |
|
| LanguageID | integer |
None. |
|
| VoucherPackID | integer |
None. |
|
| EducationPackID | integer |
None. |
|
| EventFormat | string |
None. |
|
| InstructorID | integer |
None. |
|
| NameKeyOld | string |
None. |
|
| ZoomID | string |
None. |
|
| UpdateOffSaleDate | boolean |
None. |
|
| IsFreeDigital | boolean |
None. |
|
| IsTestEvent | boolean |
None. |
|
| RequireAddress | boolean |
None. |
|
| Is1on1 | boolean |
None. |
|
| DigitalEducationID | integer |
None. |
|
| InSalonLocationID | integer |
None. |
|
| ShowQRCode | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ID": 1,
"SiteID": 1,
"PageID": 1,
"LocationID": 1,
"ClassID": 1,
"EventTypeID": 1,
"EventScheduleID": 2,
"StartDateTime": "2026-09-22T13:02:49.3787717-07:00",
"EndDateTime": "2026-09-22T13:02:49.3787717-07:00",
"TimeZone": "sample string 3",
"RecurScheme": 4,
"Recurrence": 1,
"RecurDayOfMonth": 1,
"RecurMonthWeek": 1,
"RecurMonthWeekDay": 1,
"RecurTimeout": "2026-09-22T13:02:49.3787717-07:00",
"RecurIntervals": 1,
"MonStartTime": "sample string 5",
"MonEndTime": "sample string 6",
"TueStartTime": "sample string 7",
"TueEndTime": "sample string 8",
"WedStartTime": "sample string 9",
"WedEndTime": "sample string 10",
"ThuStartTime": "sample string 11",
"ThuEndTime": "sample string 12",
"FriStartTime": "sample string 13",
"FriEndTime": "sample string 14",
"SatStartTime": "sample string 15",
"SatEndTime": "sample string 16",
"SunStartTime": "sample string 17",
"SunEndTime": "sample string 18",
"Title": "sample string 19",
"NameKey": "sample string 20",
"Description": "sample string 21",
"Summary": "sample string 22",
"PDFAgenda": "sample string 23",
"PDFTools": "sample string 24",
"PDFText": "sample string 25",
"SendCheckIn": true,
"CheckInMessage": "sample string 27",
"PromoInstruct": "sample string 28",
"TicketsAvailable": "sample string 29",
"ContactName": "sample string 30",
"ContactPhone": "sample string 31",
"ContactEmail": "sample string 32",
"InfoURL": "sample string 33",
"FormAttachID": 34,
"BCCEmails": "sample string 35",
"CustomHeaderID": 1,
"CustomLogoID": 1,
"CustomPDFImageID": 1,
"CostCenterID": 1,
"BrandID": 1,
"BrandName": "sample string 36",
"Artist": "sample string 37",
"Price": "sample string 38",
"MaxTickets": "sample string 39",
"Points": "sample string 40",
"Brand": "sample string 41",
"Active": true,
"SortPriority": 43.0,
"CreatedDate": "2026-09-22T13:02:49.3944013-07:00",
"LastUpdatedDate": "2026-09-22T13:02:49.3944013-07:00",
"CreatedBy": 46,
"UpdatedBy": 47,
"CancelledDate": "2026-09-22T13:02:49.3944013-07:00",
"CancelledBy": 1,
"CountryCd": 48,
"IsVoucher": true,
"IsCustom": true,
"HideTime": true,
"HideMap": true,
"FollowUpSent": true,
"FollowUpSentDate": "2026-09-22T13:02:49.3944013-07:00",
"FollowUpSurveyID": 54,
"NonCompleted": true,
"LanguageID": 56,
"VoucherPackID": 57,
"EducationPackID": 58,
"EventFormat": "sample string 59",
"InstructorID": 60,
"NameKeyOld": "sample string 61",
"ZoomID": "sample string 62",
"UpdateOffSaleDate": true,
"IsFreeDigital": true,
"IsTestEvent": true,
"RequireAddress": true,
"Is1on1": true,
"DigitalEducationID": 68,
"InSalonLocationID": 69,
"ShowQRCode": true
},
{
"ID": 1,
"SiteID": 1,
"PageID": 1,
"LocationID": 1,
"ClassID": 1,
"EventTypeID": 1,
"EventScheduleID": 2,
"StartDateTime": "2026-09-22T13:02:49.3787717-07:00",
"EndDateTime": "2026-09-22T13:02:49.3787717-07:00",
"TimeZone": "sample string 3",
"RecurScheme": 4,
"Recurrence": 1,
"RecurDayOfMonth": 1,
"RecurMonthWeek": 1,
"RecurMonthWeekDay": 1,
"RecurTimeout": "2026-09-22T13:02:49.3787717-07:00",
"RecurIntervals": 1,
"MonStartTime": "sample string 5",
"MonEndTime": "sample string 6",
"TueStartTime": "sample string 7",
"TueEndTime": "sample string 8",
"WedStartTime": "sample string 9",
"WedEndTime": "sample string 10",
"ThuStartTime": "sample string 11",
"ThuEndTime": "sample string 12",
"FriStartTime": "sample string 13",
"FriEndTime": "sample string 14",
"SatStartTime": "sample string 15",
"SatEndTime": "sample string 16",
"SunStartTime": "sample string 17",
"SunEndTime": "sample string 18",
"Title": "sample string 19",
"NameKey": "sample string 20",
"Description": "sample string 21",
"Summary": "sample string 22",
"PDFAgenda": "sample string 23",
"PDFTools": "sample string 24",
"PDFText": "sample string 25",
"SendCheckIn": true,
"CheckInMessage": "sample string 27",
"PromoInstruct": "sample string 28",
"TicketsAvailable": "sample string 29",
"ContactName": "sample string 30",
"ContactPhone": "sample string 31",
"ContactEmail": "sample string 32",
"InfoURL": "sample string 33",
"FormAttachID": 34,
"BCCEmails": "sample string 35",
"CustomHeaderID": 1,
"CustomLogoID": 1,
"CustomPDFImageID": 1,
"CostCenterID": 1,
"BrandID": 1,
"BrandName": "sample string 36",
"Artist": "sample string 37",
"Price": "sample string 38",
"MaxTickets": "sample string 39",
"Points": "sample string 40",
"Brand": "sample string 41",
"Active": true,
"SortPriority": 43.0,
"CreatedDate": "2026-09-22T13:02:49.3944013-07:00",
"LastUpdatedDate": "2026-09-22T13:02:49.3944013-07:00",
"CreatedBy": 46,
"UpdatedBy": 47,
"CancelledDate": "2026-09-22T13:02:49.3944013-07:00",
"CancelledBy": 1,
"CountryCd": 48,
"IsVoucher": true,
"IsCustom": true,
"HideTime": true,
"HideMap": true,
"FollowUpSent": true,
"FollowUpSentDate": "2026-09-22T13:02:49.3944013-07:00",
"FollowUpSurveyID": 54,
"NonCompleted": true,
"LanguageID": 56,
"VoucherPackID": 57,
"EducationPackID": 58,
"EventFormat": "sample string 59",
"InstructorID": 60,
"NameKeyOld": "sample string 61",
"ZoomID": "sample string 62",
"UpdateOffSaleDate": true,
"IsFreeDigital": true,
"IsTestEvent": true,
"RequireAddress": true,
"Is1on1": true,
"DigitalEducationID": 68,
"InSalonLocationID": 69,
"ShowQRCode": true
}
]
application/xml, text/xml
Sample:
<ArrayOfTools_Events xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ElabDataAccess">
<Tools_Events>
<Active>true</Active>
<Artist>sample string 37</Artist>
<BCCEmails>sample string 35</BCCEmails>
<Brand>sample string 41</Brand>
<BrandID>1</BrandID>
<BrandName>sample string 36</BrandName>
<CancelledBy>1</CancelledBy>
<CancelledDate>2026-09-22T13:02:49.3944013-07:00</CancelledDate>
<CheckInMessage>sample string 27</CheckInMessage>
<ClassID>1</ClassID>
<ContactEmail>sample string 32</ContactEmail>
<ContactName>sample string 30</ContactName>
<ContactPhone>sample string 31</ContactPhone>
<CostCenterID>1</CostCenterID>
<CountryCd>48</CountryCd>
<CreatedBy>46</CreatedBy>
<CreatedDate>2026-09-22T13:02:49.3944013-07:00</CreatedDate>
<CustomHeaderID>1</CustomHeaderID>
<CustomLogoID>1</CustomLogoID>
<CustomPDFImageID>1</CustomPDFImageID>
<Description>sample string 21</Description>
<DigitalEducationID>68</DigitalEducationID>
<EducationPackID>58</EducationPackID>
<EndDateTime>2026-09-22T13:02:49.3787717-07:00</EndDateTime>
<EventFormat>sample string 59</EventFormat>
<EventScheduleID>2</EventScheduleID>
<EventTypeID>1</EventTypeID>
<FollowUpSent>true</FollowUpSent>
<FollowUpSentDate>2026-09-22T13:02:49.3944013-07:00</FollowUpSentDate>
<FollowUpSurveyID>54</FollowUpSurveyID>
<FormAttachID>34</FormAttachID>
<FriEndTime>sample string 14</FriEndTime>
<FriStartTime>sample string 13</FriStartTime>
<HideMap>true</HideMap>
<HideTime>true</HideTime>
<ID>1</ID>
<InSalonLocationID>69</InSalonLocationID>
<InfoURL>sample string 33</InfoURL>
<InstructorID>60</InstructorID>
<Is1on1>true</Is1on1>
<IsCustom>true</IsCustom>
<IsFreeDigital>true</IsFreeDigital>
<IsTestEvent>true</IsTestEvent>
<IsVoucher>true</IsVoucher>
<LanguageID>56</LanguageID>
<LastUpdatedDate>2026-09-22T13:02:49.3944013-07:00</LastUpdatedDate>
<LocationID>1</LocationID>
<MaxTickets>sample string 39</MaxTickets>
<MonEndTime>sample string 6</MonEndTime>
<MonStartTime>sample string 5</MonStartTime>
<NameKey>sample string 20</NameKey>
<NameKeyOld>sample string 61</NameKeyOld>
<NonCompleted>true</NonCompleted>
<PDFAgenda>sample string 23</PDFAgenda>
<PDFText>sample string 25</PDFText>
<PDFTools>sample string 24</PDFTools>
<PageID>1</PageID>
<Points>sample string 40</Points>
<Price>sample string 38</Price>
<PromoInstruct>sample string 28</PromoInstruct>
<RecurDayOfMonth>1</RecurDayOfMonth>
<RecurIntervals>1</RecurIntervals>
<RecurMonthWeek>1</RecurMonthWeek>
<RecurMonthWeekDay>1</RecurMonthWeekDay>
<RecurScheme>4</RecurScheme>
<RecurTimeout>2026-09-22T13:02:49.3787717-07:00</RecurTimeout>
<Recurrence>1</Recurrence>
<RequireAddress>true</RequireAddress>
<SatEndTime>sample string 16</SatEndTime>
<SatStartTime>sample string 15</SatStartTime>
<SendCheckIn>true</SendCheckIn>
<ShowQRCode>true</ShowQRCode>
<SiteID>1</SiteID>
<SortPriority>43</SortPriority>
<StartDateTime>2026-09-22T13:02:49.3787717-07:00</StartDateTime>
<Summary>sample string 22</Summary>
<SunEndTime>sample string 18</SunEndTime>
<SunStartTime>sample string 17</SunStartTime>
<ThuEndTime>sample string 12</ThuEndTime>
<ThuStartTime>sample string 11</ThuStartTime>
<TicketsAvailable>sample string 29</TicketsAvailable>
<TimeZone>sample string 3</TimeZone>
<Title>sample string 19</Title>
<TueEndTime>sample string 8</TueEndTime>
<TueStartTime>sample string 7</TueStartTime>
<UpdateOffSaleDate>true</UpdateOffSaleDate>
<UpdatedBy>47</UpdatedBy>
<VoucherPackID>57</VoucherPackID>
<WedEndTime>sample string 10</WedEndTime>
<WedStartTime>sample string 9</WedStartTime>
<ZoomID>sample string 62</ZoomID>
</Tools_Events>
<Tools_Events>
<Active>true</Active>
<Artist>sample string 37</Artist>
<BCCEmails>sample string 35</BCCEmails>
<Brand>sample string 41</Brand>
<BrandID>1</BrandID>
<BrandName>sample string 36</BrandName>
<CancelledBy>1</CancelledBy>
<CancelledDate>2026-09-22T13:02:49.3944013-07:00</CancelledDate>
<CheckInMessage>sample string 27</CheckInMessage>
<ClassID>1</ClassID>
<ContactEmail>sample string 32</ContactEmail>
<ContactName>sample string 30</ContactName>
<ContactPhone>sample string 31</ContactPhone>
<CostCenterID>1</CostCenterID>
<CountryCd>48</CountryCd>
<CreatedBy>46</CreatedBy>
<CreatedDate>2026-09-22T13:02:49.3944013-07:00</CreatedDate>
<CustomHeaderID>1</CustomHeaderID>
<CustomLogoID>1</CustomLogoID>
<CustomPDFImageID>1</CustomPDFImageID>
<Description>sample string 21</Description>
<DigitalEducationID>68</DigitalEducationID>
<EducationPackID>58</EducationPackID>
<EndDateTime>2026-09-22T13:02:49.3787717-07:00</EndDateTime>
<EventFormat>sample string 59</EventFormat>
<EventScheduleID>2</EventScheduleID>
<EventTypeID>1</EventTypeID>
<FollowUpSent>true</FollowUpSent>
<FollowUpSentDate>2026-09-22T13:02:49.3944013-07:00</FollowUpSentDate>
<FollowUpSurveyID>54</FollowUpSurveyID>
<FormAttachID>34</FormAttachID>
<FriEndTime>sample string 14</FriEndTime>
<FriStartTime>sample string 13</FriStartTime>
<HideMap>true</HideMap>
<HideTime>true</HideTime>
<ID>1</ID>
<InSalonLocationID>69</InSalonLocationID>
<InfoURL>sample string 33</InfoURL>
<InstructorID>60</InstructorID>
<Is1on1>true</Is1on1>
<IsCustom>true</IsCustom>
<IsFreeDigital>true</IsFreeDigital>
<IsTestEvent>true</IsTestEvent>
<IsVoucher>true</IsVoucher>
<LanguageID>56</LanguageID>
<LastUpdatedDate>2026-09-22T13:02:49.3944013-07:00</LastUpdatedDate>
<LocationID>1</LocationID>
<MaxTickets>sample string 39</MaxTickets>
<MonEndTime>sample string 6</MonEndTime>
<MonStartTime>sample string 5</MonStartTime>
<NameKey>sample string 20</NameKey>
<NameKeyOld>sample string 61</NameKeyOld>
<NonCompleted>true</NonCompleted>
<PDFAgenda>sample string 23</PDFAgenda>
<PDFText>sample string 25</PDFText>
<PDFTools>sample string 24</PDFTools>
<PageID>1</PageID>
<Points>sample string 40</Points>
<Price>sample string 38</Price>
<PromoInstruct>sample string 28</PromoInstruct>
<RecurDayOfMonth>1</RecurDayOfMonth>
<RecurIntervals>1</RecurIntervals>
<RecurMonthWeek>1</RecurMonthWeek>
<RecurMonthWeekDay>1</RecurMonthWeekDay>
<RecurScheme>4</RecurScheme>
<RecurTimeout>2026-09-22T13:02:49.3787717-07:00</RecurTimeout>
<Recurrence>1</Recurrence>
<RequireAddress>true</RequireAddress>
<SatEndTime>sample string 16</SatEndTime>
<SatStartTime>sample string 15</SatStartTime>
<SendCheckIn>true</SendCheckIn>
<ShowQRCode>true</ShowQRCode>
<SiteID>1</SiteID>
<SortPriority>43</SortPriority>
<StartDateTime>2026-09-22T13:02:49.3787717-07:00</StartDateTime>
<Summary>sample string 22</Summary>
<SunEndTime>sample string 18</SunEndTime>
<SunStartTime>sample string 17</SunStartTime>
<ThuEndTime>sample string 12</ThuEndTime>
<ThuStartTime>sample string 11</ThuStartTime>
<TicketsAvailable>sample string 29</TicketsAvailable>
<TimeZone>sample string 3</TimeZone>
<Title>sample string 19</Title>
<TueEndTime>sample string 8</TueEndTime>
<TueStartTime>sample string 7</TueStartTime>
<UpdateOffSaleDate>true</UpdateOffSaleDate>
<UpdatedBy>47</UpdatedBy>
<VoucherPackID>57</VoucherPackID>
<WedEndTime>sample string 10</WedEndTime>
<WedStartTime>sample string 9</WedStartTime>
<ZoomID>sample string 62</ZoomID>
</Tools_Events>
</ArrayOfTools_Events>