Skip to main content

 Services

Web services from /about to /webhooks

member

/members/{member} [GET]

Description

Get the member’s personal details.

This service can also be used to return the details of a member prior to activation if a valid and current activation token matching the member is provided as a parameter on the request.

This service doesn’t activate the member but uses the activation or reset password token to return the member details.

Parameters

NameDescriptionRequiredTypeDefault
tokenAn activation or reset password token for the membernostring

Permission

Only the member herself, or an administrator, can invoke this service unless a valid token issued for this member is used in lieu of authentication.

Response

This service returns the extended <member> element and includes the email address.

If the token parameter was included, valid and current, the XML also includes the admin flag.

The XML returned is always:

<member id="[member id]"
        firstname="[first name]"
        surname="[surname]"
        username="[username]"
        status="[activated|set-password|unactivated]"
        [onvacation="true"]
        [attachments="true"]
        [created="[date]"]
        [activated="[date]"]
        [lastpasswordchange="[date]"]
        [lastlogin="[date]"]
        [locked="true"]
        [admin="date"] >
  <fullname>[full name]</fullname>
</member>

For example:

<member id="123" 
        firstname="Joan" 
        surname="Smith"
        username="jsmith" 
        status="activated">
  <fullname>Joan Smith</fullname>
</member>

Error Handling

No specific errors expected for this service.

Created on , last edited on