Get user list

Get a list of users

This API call is used to retrieve a list of users from the system.

Note:

1. New query parameters introduced with this version are:

 neverlogin, neverinvited, notingroup, ordertype, orderby, orgid, groupid, externalid, firstname, lastname, email, search

2. Introduced fields totalcount, total
3. Introduced the following fields for the response body 

emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
4. The "location" tag has been renamed to "address" tag to make it consistent with the Collaborate UI 

5. In every GET API # value for search is not supported because the jersey framework itself does not support #.

    After # all the parameters/values will be ignored.

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

GET   /api/3/users?status={status}& offset={offset}&limit={limit}&

neverlogin={true|false}&

neverinvited={true|false}&

notingroup={true|false}

ordertype={ordertype}&

orderby={orderby}&

orgid={organisation id csv}&

groupid={group id csv}&

externalid={external id}&

firstname={first name}&

lastname={last name}&

email={email}&

search={firstname OR lastname OR email OR externalid}

alphabets={lastname starting with}&

jobtitle={job title pipe separated value}&

departments={department id pipe separated value}&

locations={address city pipe separated value}&

organisations={org name pipe separated value}&

specialities={user specialities pipe separated value}

URL Query Parameters

Example

GET   /api/3/users? status=active&offset=10&limit=50&

neverlogin=false&

neverinvited=true&

notingroup=true

ordertype=organisation&

orderby=desc&

orgid=1001,1002&

groupid=3,5&

externalid=user_123&

firstname=abc&

lastname=xyz&

email=abc.xyz@gmail.com&

search=xyz

alphabets=c

jobtitle=business analyst|qa engineer

departments=IT|Research and Developement

locations=Calgary|London city

organisations=HighQ|Allen and Overy

specialities=abc def|uv wxyz

Notes :

• The value of limit parameter has the following behaviour:
  • If no value is provided in the limit, 100 is used as the default value.
  • If the limit is higher than 0, then it uses that value as limit.
  • To return all the records use -1 for the limit.
  • If the limit is lower than -1 then the limit value is set to a default value of 100.
• The value of the offset parameter has the following behaviour:
  • If no value is provided in the offset, 0 is used as the default value.
  • If the offset is lower than 0,  then an offset value is set to be a default value of 0.
  • If the offset is higher than 0 and less than the number of records in the user list, then the records starting from the offset value are returned.
  • If the offset is higher than the total number of records in the user list, then the offset has a default value of 0.

HTTP Response

Success

HTTP response is 200 with a list of user summary object 

Error

See API Error messages

XML response

<users>
    <total>506</total>
    <totalcount>1</totalcount>
    <user>
        <userid>134</userid>
        <name>
            <firstname>Tom</firstname>
            <lastname>Chick</lastname>
        </name>
        <email>tom.chick7@highq.com</email>
        <jobtitle>Senior Solution Architect</jobtitle>
        <mobile>91$8918291212</mobile>
        <department>IT</department>
        <status>Active</status>
        <organisation>
            <orgname>HighQ</orgname>
            <orgid>1</orgid>
        </organisation>
        <invited></invited>
        <lastlogin></lastlogin>
        <externalid></externalid>
        <avatar>0</avatar>
        <address>
            <addressline1>404, 5th Ave</addressline1>
            <addressline2></addressline2>
            <city>New York</city>
            <country>USA</country>
            <state></state>
        </address>
        <specialities> java, dotnet</specialities>
        <phone>91$079$81716551</phone>
        <invalidlogins>0</invalidlogins>
    </user>
</users>

JSON response

{
    "total": "506",
    "totalcount": "1",
    "user": [
        {
            "userid": 134,
            "name": {
                "firstname": "Tom",
                "lastname": "Chick"
            },
            "email": "tom.chick7@highq.com",
            "jobtitle": "Senior Solution Architect",
            "mobile": "91$8918291212",
            "department": "IT",
            "status": "Active",
            "organisation": {
                "orgname": "HighQ",
                "orgid": 1
            },
            "invited": "",
            "lastlogin": "",
            "externalid": "",
            "avatar": 0,
            "address": {
                "addressline1": "404, 5th Ave",
                "addressline2": "",
                "city": "New York",
                "state": "",
                "country": "USA"
            },
            "specialities": " java, dotnet",
            "phone": "91$079$81716551",
            "invalidlogins": 0
        }
    ]

Error messages