find members
/members/find [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9500 | 5.9700 | json, xml |
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
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| emaildomain | The domain the member's email must have | no | string | |
| 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 | no | boolean | false |
| status | The member status ('disabled', 'set-password', 'unactivated' or 'activated') | no | enum |
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.