Web service API

How to use PageSeeder's Web service API

find members

/members/find [GET]

com.pageseeder.member.FindMembers

Description

Finds members.

If there is a group on the request only returns direct members of groups under the top ancestor project.

The returned XML is as follows:

 <members [limitreached="true"]>
   <member id="[member id]"
    firstname="[first name]"
      surname="[surname]"
     username="[username]"
        email="[email]"
       status="[activated|unactivated|set-password]">
     <fullname>[full name]</fullname>
   </member>
   ...
 </members>
 

Parameters

Name Description Required Type Default value
emaildomain
page the page to load no integer 1
pagesize the number of results per page no integer 1000
prefix prefix member's email, firstname, surname or username must have no string

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

The returned XML is as follows:


 <members [limitreached="true"]>
   <member id="[member id]"
    firstname="[first name]"
      surname="[surname]"
     username="[username]"
        email="[email]"
       status="[activated|unactivated|set-password]">
     <fullname>[full name]</fullname>
   </member>
   ...
 </members>
 

Error Handling

No specific errors expected for this generator.

Created on , last edited on