find members
/members/find [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9500 | 5.9700 | json, xml |
Description
Finds members.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
emaildomain | ||||
page | The page to load | no | integer | 1 |
pagesize | The number of results per page | no | integer | 1000 |
prefix | Prefix member’s email, given name, family name or username must have | no | string | |
extendedmember | If extended information for member should be returned (administrators only) | no | boolean | false |
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.