find members

Description

This service lets you find members in PageSeeder by email domain and/or by matching their email, given name, family name or username with the specified prefix.

The members are sorted alphabetically by surname, first name and email.

Parameters

The maximum value for pagesize is 10000.

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>

Or in JSON

{
  "limitreached": boolean,
  "members" [{
    "id": number,
    "firstname": string,
    "surname": string,
    "username": string,
    "status": string,
    "fullname": string
  }, ...]
}

Or if extendedmember is true:

{
  "limitreached": boolean,
  "members" [{
    "id": number,
    "firstname": string,
    "surname": string,
    "username": string
    "created": datetime,
    "activated": datetime,
    "status": string,
    "fullname": string
  }, ...]
}

Error Handling

No specific errors expected for this service.