Podio API Documentation
Comments: Get comments on object
Used to retrieve the comments that have been made on an object of the given type and with the given id. It returns a list of the comments sorted in ascending order by time created.
Usage
- PHP Client
-
PodioComment.php
PodioComment::get_for( $ref_type, $ref_id ); - Ruby Gem
-
comment.rb
Podio::Comment.find_all_for( commentable_type, commentable_id )
Parameters
- type*
- Required.
- id*
- Required.
- limit
The maximum number of comments to return
Default value: 100- offset
The offset into the comments
Default value: 0
Response
[
{
"comment_id": The id of the comment. Can be used to update and delete the comment,
"value": The actual comment,
"external_id": The external id set on the comment, if any,
"ref": The reference to the object the comment is on,
{
"type": The type of the reference,
"id": The id of the reference
},
"like_count": The total number of likes on this status,
"is_liked": True if the active user has liked the status, false otherwise,
"created_by": The entity who created the comment,
"created_via": The interface through which the comment was created,
"created_on": The date and time the comment was created,
"files": The files on the comment,
[
{
"file_id": The id of the file,
"name": The name of the file,
"description": The description of the file,
"mimetype": The type of the file, see the area for allowed types,
"size": The size of the file in bytes,
}
... (more files)
]
},
..... (more comments)
]
Sandbox
Try the operation "/comment/{type}/{id}/"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