Podio API Documentation
Notifications: Get notifications
Returns a list of notifications based on the query parameters. The notifications will be grouped based on their context.
- PHP Client
-
PodioNotificationGroup.php
PodioNotificationGroup::get_all( $attributes = array() ); - Ruby Gem
-
notification_group.rb
Podio::NotificationGroup.find_all( options = {} )
- context_type
The type of the context to get notifications for, f.ex. "conversation", "item" or "task"
- created_from
The earliest date and time to return notifications from
- created_to
The latest date and time to return notifications from
- direction
"incoming" to get incoming notifications, "outgoing" to get outgoing notifications
Default value: incoming- limit
The maximum number of notifications to return, maxium is "100"
Default value: 20- offset
The offet into the returned notifications
Default value: 0- starred
False to get only unstarred notifications, true to get only starred notifications, leave blank for both
- type
A type of notification, see the area for possible types
- user_id
The user id of the other part of the notification
- viewed
False to get all unviewed notifications, true to get all viewed notifications, leave blank for both
- viewed_from
When returning only unviewed notifications (above), notifications viewed after the given date and time will also be returned. Use this to keep pagination even when some notifications has been viewed after initial page load.
[
{
"context": The context of the group of notifications,
{
"ref": The reference of the context,
{
"type": The type of the reference,
"id": The id of the reference,
},
"data": The data of the context, depends on the type of reference,
"title": The title of the context,
"rights": The list of rights the active user has on the context,
"comment_count": The number of comments on the objects (only for objects of type status, task and item),
"space": The space the context belongs to, if any
{
"space_id": The id of the space,
"name": The name of the space,
"url": The full URL of the space,
"url_label": The slug of the space
},
"org": The organization the context belongs to, if any
{
"org_id": The id of the org,
"name": The name of the org,
"url": The full URL of the org,
"url_label": The subdomain of the org
}
},
"notifications": The list of notifications for the given context,
[
{
"notification_id": The id of the notification,
"user": The user who the notification is for,
{
"user_id": The id of the user,
"name": The full name of the user,
"avatar": The avatar of the user
},
"type": The type of notification, see the area for details,
"data": The data of the notification, depends on the type of notification,
"icon": The icon for the notification, see the area for details,
"text": The text for the notification,
"text_short": A short form of the notification text, to be used within an established context,
"viewed_on": The date and time when the notification was viewed,
"starred": True if the notification is starred, false otherwise,
"subscription_id": The id of the subscription this notification was from, if any,
"created_on": The date and time when the notification was created,
"created_by": The entity who created the notification,
"created_via": The interface used when creating the notification,
},
... (more notifications)
]
},
... (more)
]
Sandbox
Try the operation "/notification/"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