Skip to main content

 Web service API

How to use PageSeeder's Web service API

find members

/members/find [GET]

com.pageseeder.member.FindMembers

Description

Finds members.

Parameters

NameDescriptionRequiredTypeDefault value
emaildomain
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger1000
prefixPrefix member’s email, given name, family name or username must havenostring
extendedmemberIf extended information for member should be returned (administrators only)nobooleanfalse

Permission

This service requires administrator.

Response

This service returns a list of <member> elements wrapped in a <members> element.

<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 service.

Created on , last edited on