Get a feed of a file's comments 

Get a feed that lists all of the comments associated with a file.

Table 1. Atom API request details

Resource Description
/basic/anonymous/api/userlibrary/{userid}/document/{document-id}/feed?category=comment A feed of comments associated with all public files. Do not authenticate this request.
/basic/api/userlibrary/{userid}/document/{document-id}/feed?category=comment A feed of comments associated with files to which you have access. You must authenticate this request.

{document-id} is the value of the <td:uuid> or <td:label> elements in the file's Atom entry document and {userid} is the value of the person's <snx:userid>. See Search Profiles to find out how to determine a person's user ID.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Table 2. Input parameters

Parameter Description
acls Specifies whether or not the permissions for each user should be displayed for each entry in the returned feed. This parameter takes a Boolean value of either true or false. By default, the permission information is not returned.

Note: This parameter is required.

Resource type to include in the response. This parameter should always be set to comment. If you do not specify a category, comment is returned.
commentId Specifies the relative returned comments. If provided, page and sI are ignored.
identifier Indicates how the document is identified in the {document-id} variable segment of the web address. By default, look up is performed with the expectation that the URL contains the value from the <td:uuid> element of a file Atom entry. Options are uuid and label. Specify label if the URL instead contains the value from the <td:label> element of a file Atom entry.
page Page number. Specifies the page to be returned assuming a constant page size. The default value is 1.
pageSize Page size. Specifies the number of items to include in a paged request. The default value is 10. Specify the page size in increments of ten.
sI Start index. Specifies the start index (as a number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
sortBy String. Specifies what to sort the returned entries by. Options are:

    Organize the entries by comment creation date.


    Organize the entries by comment modification date.


    Organize the entries by comment publication date.


    Organize the entries by the date on which the comment was updated.

The default value of this parameter is modified.

sortOrder String. Defines the order in which to sort the results. Options are:




If a value is specified for the sortBy parameter, but none is specified for this parameter, then this parameter defaults to asc. If neither is specified, this parameter defaults to desc.

Parent topic

Getting Files feeds

Related reference
Search Profiles programmatically