Jump to content

Community

REST API Documentation

/calendar/events


Get list of events

For requests using an OAuth Access Token for a particular member, only events the authorized user can view will be included


Parameters

Name Type Description
calendars string Comma-delimited list of calendar IDs
authors string Comma-delimited list of member IDs - if provided, only events started by those members are returned
locked int If 1, only events which are locked are returned, if 0 only unlocked
hidden int If 1, only events which are hidden are returned, if 0 only not hidden
featured int If 1, only events which are featured are returned, if 0 only not featured
rangeStart string YYYY-MM-DD. Only events occurring on or after this date will be returned.
rangeEnd string YYYY-MM-DD. Only events occurring on or before this date will be returned.
sortBy string What to sort by. Can be 'date' for creation date, 'start' for event start date, 'end' for event end date, 'title' or leave unspecified for ID
sortDir string Sort direction. Can be 'asc' or 'desc' - defaults to 'asc'
page int Page number
perPage int Number of results per page - defaults to 25

Exceptions

Code Message Description
1L296/M INVALID_DATE The rangeStart and/or rangeEnd value was not a valid date in YYYY-MM-DD format

Response

Name Type Description
page int The page number for the results being shown
perPage int The number of results that will be on each page
totalResults int The total number of results
totalPages int The number of pages of results
results array of event objects The results for this page

event object

Name Type Description
id int ID number
title string Title
calendar calendar object Calendar
start datetime Event start time
end datetime Event end time
recurrence string If this event recurs, the ICS recurrence definition
rsvp bool If this event accepts RSVPs
rsvpLimit int The number of RSVPs the event is limited to
location geolocation object The location where the event is taking place
venue venue object The venue data
author member object The member that created the event
postedDate datetime When the event was created
description string Event description
comments int Number of comments
reviews int Number of reviews
views int Number of posts
prefix string The prefix tag, if there is one
tags array of strings The tags
locked bool Event is locked
hidden bool Event is hidden
featured bool Event is featured
url string URL

calendar object

Name Type Description
id int ID number
name string Name
url string URL
class string Node class
permissions bject|null object Node permissions

geolocation object

Name Type Description
lat float Latitude
long float Longitude
addressLines array of strings Lines of the street address
city string City
region string State/Region
country string 2-letter country code
postalCode string ZIP/Postal Code

venue object

Name Type Description
id int ID number
title string Title
description string Description
address geolocation object The address

member object

Name Type Description
id int ID number
name string Username
title string Member title
timezone string Member timezone
formattedName string Username with group formatting
ipAddress string IP address used during registration
primaryGroup group object Primary group
secondaryGroups array of group objects Secondary groups
email string Email address
joined datetime Registration date
registrationIpAddress string IP address when registered
warningPoints int Number of active warning points
reputationPoints int Number of reputation points
photoUrl string URL to photo (which will be the site's default if they haven't set one)
photoUrlIsDefault bool Indicates if the value of photoUrl is the site's default
coverPhotoUrl string URL to profile cover photo (will be blank if there isn't one)
profileUrl tring|null object URL to profile
validating bool Whether or not the validating flag is set on the member account
posts int Number of content item submissions member has made
lastActivity atetime|null object Last activity date on the site
lastVisit atetime|null object Last distinct visit date on the site
lastPost atetime|null object Latest content submission date
profileViews int Number of times member's profile has been viewed
birthday string Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied)
customFields array of fieldgroup objects Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting

fieldgroup object

Name Type Description
name string Group name
fields array of field objects Fields

field object

Name Type Description
name string Field name
value string Value
×
×
  • Create New...