Page tree




Returns a list of events based on the locationid for the current month unless a specified date range is supplied. Locationid can be a non-primary locationid.




pageIndex and pageSize are not required for the API to work properly. These fields let you limit the number of records returned at one time and when you begin pulling information. If you do not enter this information, the index default is 0 and the size default is 50. 

For example, suppose you're looking for all the individuals with the first name John. 300 records match your criteria. If you leave the defaults, the first 50 matches display. If you change the pageIndex to 2, the next 50 matches are returned.

Use the MM/DD/YYYY format when entering dates.

Required Permissions

The user must fall into one of the categories below:

  • System Administration

  • A user with the following rights:

    • Rights to view at least one Calendar

    • All Rights to all Calendars

You will only see the events on calendars you have view rights to.

Request Header

Basic Authorization is used to determine security rights for the user credentials supplied using the following parameters.

username: "jadams"

password: "password231"

URL Parameters

site_number – The site number to gather data for.

location_id – The location the events will be pulled from.  Values from the Facility Scheduler Get List of Locations API.  

start_date – The date to start pulling events from. (Optional)

stop_date – The date to stop pulling events from. (Optional)

Return Data

  "Page": [
      "Description": null,
      "EventDateId": "3c7c8f40-7eab-4efe-aa76-a355009af705",
      "EventId": "0a5d8e2a-3a78-4c80-9c00-a04b00f7cb20",
      "EventName": "Chancel Choir Rehearsal",
      "EventType": null,
      "EventTypeId": null,
      "IsPublished": true,
      "LocationId": "f88abfb0-9656-4284-b675-b89974d5a757",
      "Location": "Choir Rehearsal Hall",
      "StartDate": "2015-08-16 10:00:00.000",
      "StopDate": "2015-08-16 10:20:00.000",
      "Status": "Confirmed",
      "CalendarName": "Make a Joyful Noise (Choir)",
      "IsRecurringEvent": true,
      "CalendarId": "6ce6d1ff-7532-4a38-876a-94e75cc43cde",
      "AllowRegistration": false
      "DateModified": "",
      "Note": ""
  "PageCount": 1,
  "PageIndex": 0,
  "PageSize": 50


You may only pull one location at a time.