members

Description

Returns the members on the server.

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

By default, this service returns the first 1000 members and up to 10000 at a time using the pagesize parameter. Use the page parameter to return additional members.

Alternatively, you can use the /members/find service to return members matching a name, email or email domain.

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,
    "email": string,
    "status": string,
    "fullname": string
  }, ...]
}

Or if extendedmember is true:

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

Error Handling

No specific errors expected for this service.