Web service API

How to use PageSeeder's Web service API

find comments

/members/{member}/comments/find [GET]



Load a list of comments using filter parameters.

This service performs the same as Service: /comments/find [GET] but will return any comments that {member} has access to.


NameDescriptionRequiredTypeDefault value
groupsA comma-separated list of group names the comments must belong to.yesstrings
archivedIf "true", include archived comments.nobooleanfalse
attachmentsThe attachments to include
(can be "none", "context" or "all").
authorThe ID of the comments author.nolong
contentsThe contents to include
(can be "none" or "all").
contextThe context for the comments (can be "group", "uri", "all").noenumall
createdafterThe date time after which the comments were created e.g. 2010-10-25T12:26:00+10:00.nodatetime
createdbeforeThe date time before which the comments were created e.g. 2011-08-25T10:20:00-04:00.nodatetime
emailsThe emails to include 
(can be "none" or "all"). Administrator use ONLY.
labelsA comma-separated list of label values.nostring
moderatedIf "true", include moderated (not accepted) comments.nobooleanfalse
pageThe page to load.nolong1
pagesizeThe number of results per page.no long1000
pathsThe context URI paths for the comments – MUST be URL encoded (comma-separated list with optional * suffix).nopaths
positionIf "first", only search first comment in a discussion (may be faster when using paths).nostringany
returngroupsThe groups to return in the output (can be "none", "specified").noenum"none" or if multiple groups "specified"
statusesComma-separated list of statuses.nostring
titleThe title the comments MUST have (optional wild card * suffix, use ** to escape).nostring
typeThe type the comments MUST have (optional wild card * suffix, use ** to escape).nostring
typesComma-separated list of types the comment can have (empty string means no type).nostrings


The member in the request must have access to all the groups in the groups parameter. If the emails parameter is set to all, then the service is restricted to administrators only.


The output has the following format:

    <comment id="234"
             contentrole="File Attachment"
        <title>My thread</title>
        <content type="text/plain">Some text</content>
            <uri id="189"> ... </uri>
        <attachment fragment="5">
            <uri id="289"> ... </uri>
            <group  id="3"
                    name="acme-test" />
    <comment id="567">
        <context fragment="2">
            <uri id="789"> ... </uri>

Error Handling

CodeCause / Description
0x1306The Group is invalid or not accessible
0x1312The createdafter or createdbefore date is invalid
0x1313The author is invalid


Created on , last edited on