Podio API Documentation
Calendar: Get calendar summary
Returns the calendar summary for the active user
Usage
- PHP Client
-
PodioCalendarEvent.php
PodioCalendarEvent::get_summary( $attributes = array() ); - Ruby Gem
-
calendar_event.rb
Podio::CalendarEvent.find_summary( options = {} )
Parameters
- limit
The maximum number of events to return in each group
Default value: 5- priority
The minimum priority for the events to return
Default value: 1
Response
{
"today": The summary for today,
{
"total": The total number of events,
"events": The first events, limited by the limit parameter
[
{
"type": The type of the entry, either "task", "item" or "meeting",
"id": The id of the entry,
"group": The group of the object, null for tasks and app item name for items,
"title": The title of the entry,
"start": The start date,
"start_date": The date part of the start,
"start_time": The time part of the start, if any,
"end": The end date if entry, if any,
"end_date": The date part of the end, if any,
"end_time": The time part of the end, if any,
"link": The full link to the object,
"app": The app the object belongs to, if any,
{
"app_id": The id of the app,
"name": The name of the app,
"item_name": The name of items in the app,
"icon": The icon of the app
}
},
... (more events up to the limit)
]
},
"upcoming": The summary for the next 6 following days
{
... (same as the today group above)
}
}
Sandbox
Try the operation "/calendar/summary"You can simulate the API request by filling out the arguments below, and press the submit button to see the response.
You need to be logged in to Podio to use the Sandbox. Login here