Get user
OVERVIEW
Get a user from Collaborate
This API call is used to retrieve a user from the system.
Note:
1. The following fields have been introduced in this version
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. The "location" tag has been renamed to "address" tag to make it consistent with the Collaborate UI
The response will now display the address as
<address>
<addressid>1</addressid>
<addressline1>2nd floor</addressline1>
<addressline2>additional</addressline2>
<city>london</city>
<state>state</state>
<country>uk</country>
<postCode>EC4R</postCode>
</address>
instead of
<location>
<addressline1>2nd floor, 55 King William Street</addressline1>
<addressline2>additional</addressline2>
<addressline3>state</addressline3>
<city>London</city>
<country>United Kingdom</country>
<postcode>EC4R 9AD</postcode>
</location>
HTTP Request
1. Get user by userId : GET /users/{userid}
2. Get user by email : GET /users/{email}?type=email
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the user to retrieve |
The email of the user to get |
Example
GET http://example.com/context/api/3/users/3
HTTP Response
Success
HTTP response 200 with user object
Response object
Error messages
Summary | Ref Code (before V4) | Ref Code (V4) |
User does not exists in the system | 110 | 110 |
Comments
0 Comments