infoodle API documentation

Return a list of events

GET /events/bydate/{from_date}/{to_date}/{location}

Search for a list of events using a date range, and location ids This allows for authenticated call - which shows events for the authenticated user, or non-authenticated call which shows only public events, i.e. events that are visible on the iternet.

Path parameters

from_date string Required

The first date to include, YYYY-MM-DD format. Date is local time
to_date string Required

The last date to include, YYYY-MM-DD format. Date is local time
location string Required

A filter based on the connection the logged in user has to the event

Values are mine, mineandpublic, rostered, public, all, or ids.

Responses

• 200

OK
Hide response attribute Show response attribute object
- events object
  
  Hide events attributes Show events attributes
  
  id integer
  
  ID of the event
  
  date string
  
  dayNumber integer
  
  dayNumberTh string
  
  dayNameAbbr string
  
  dayName string
  
  monthNameAbbr string
  
  monthName string
  
  yearNumber integer
  
  setupTime24hr string
  
  startTime24hr string
  
  endTime24hr string
  
  packDownTime24hr string
  
  setupTimeFriendly string
  
  startTimeFriendly string
  
  endTimeFriendly string
  
  packDownTimeFriendly string
  
  show_as_current string
  
  If this event is on now, then value is Y
  
  title string
  
  allDay integer
  
  1 if its an all day event, 0 otherwise
  
  description string
  
  passRequired string
  
  When COVID pass details are available, whether this is a COVID pass required event
  
  locationsDecode array[object]
  
  Hide locationsDecode attributes Show locationsDecode attributes
  
  id integer
  
  name string
  
  address string
  
  webLink string
  
  colorCode string
  
  availableInvitees array[object]
  
  List of the groups classed as invitees
  
  Hide availableInvitees attributes Show availableInvitees attributes
  
  id integer
  
  name string

GET /events/bydate/{from_date}/{to_date}/{location}

curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/events/bydate/{from_date}/{to_date}/{location} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "events": {
    "id": 68,
    "date": "2022-06-01",
    "dayNumber": 42,
    "dayNumberTh": "1st",
    "dayNameAbbr": "Wed",
    "dayName": "Wednesday",
    "monthNameAbbr": "Jun",
    "monthName": "June",
    "yearNumber": 2022,
    "setupTime24hr": "09:00",
    "startTime24hr": "09:00",
    "endTime24hr": "600",
    "packDownTime24hr": "600",
    "setupTimeFriendly": "9am",
    "startTimeFriendly": "9am",
    "endTimeFriendly": "10am",
    "packDownTimeFriendly": "10am",
    "show_as_current": "N",
    "title": "Daily Catchup Meeting",
    "allDay": 0,
    "description": "string",
    "passRequired": "N",
    "locationsDecode": [
      {
        "id": 1,
        "name": "Conference Room",
        "address": "1 High Stret, London, SW1A 1AA"
      }
    ],
    "webLink": "https://www.google.com",
    "colorCode": "f5324e",
    "availableInvitees": [
      {
        "id": 1,
        "name": "Staff"
      }
    ]
  }
}