Podio API Documentation
Views: Get view
Returns the definition for the given view. The view can be either a view id, a standard view or "last" for the last view used.
Usage
- PHP Client
-
PodioView.php
PodioView::get( $view_id ); - Ruby Gem
-
view.rb
Podio::View.find( id )
Parameters
- app_id*
- Required.
- view_id_or_name*
- Required.
Response
{
"sort_by": How the results should be sorted, see the area for details.
"sort_desc": True if the result should sorted descending, false otherwise,
"filters": The filters on this view
[
{
"key": The key of the filter (see the area for details),
"values": The value(s) to be used for filtering, depends on the type of field. See the area for details.
"humanized_values": A human-friendly text representation of values,
},
... (more filters)
],
"fields": Any specific settings for fields
{
"{field_id}": The setting for the given field
{
"delta_offset": The offset from the fields normal delta,
"width": Any specific width the field is rendered as,
"hidden": True if the field is hidden, False otherwise,
"use": The use of the column either "x_axis" or "y_axis", if any
},
... (more fields)
},
"groupings": individual groups data, if grouping is present, otherwise {}
{
"total": total count of items in all groups,
"groups": [{
"count": items count of the single group,
"avatar": url of users avatar when grouping by contact or created_by, otherwise null
"color": color of a category option when grouping by category field, otherwise null,
"value": a unique value for each group,
"label": a text label for each group
},
... (more groups)
]
},
"grouping": grouping configuration, if grouping is present, otherwise {}
{
"type": "field" or "revision" (grouping by an app field or by created_by | created_on | tags),
"value": field_id in case of "field" type, "created_by", "created_on" or "tags" in case of "revision",
"sub_value": interval granularity for date related groupings (date or calculation fields or created_on). "date", "weekday", "week", "month" or "year"
}
}
Sandbox
Try the operation "/view/app/{app_id}/{view_id_or_name}"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