User resource

Get user - Get user v1

OVERVIEW

Note: The latest specification for Collaborate 4.1.4 and above is here

Get a user from Collaborate

This API call is used to retrieve a user from the system. The user identifier is the user id of the user.

Request

GET    /users/{userid}

        

Response

<user >

<userid>1</userid>                                                                                                      

<firstname>Joe</firstname>                                    

<lastname>Blow</lastname>                                                                                    

<email> joe@domain.com</email>                                

<phone>+44 (0) 207 1111 0000</phone>

<mobile>8989898989</mobile>                          

<department>marketing</department>                                        

<org>ORG001</org>                                             

<location>                                                    

<addressline1> 10< addressline1>                              

<addressline2> some road </ addressline1>                     

<city> london </city>                                         

<state> london </state>                                       

<country> UK </country>

<postCode>EC3R 7LP</postCode>                                       

</location>                                                  

<sociallinks>

        <link>

            <name>LinkedIn</name>

            <value>http://www.linkin.com/joe.blow</value>

        </link>

    </sociallinks>

    <messaginglink>

        <link>

            <name>Skype</name>

            <value>joe.blow.skype</value>

        </link>

    </messaginglink>

    <jobtitle>software engineer</jobtitle>

    <secretaryname>Mr John</secretaryname>

    <secretarymail>times@india.com</secretarymail>

    <specialities>java,dotNet</specialities>

    <title>Title</title>

    <bio>I am from HighQ</bio>                                

</user>  

 

Code Meaning
200 Successfully
400

Problem with parsing XML or JSON object (Bad Request)
401 Unauthorised
403 Validation failed/ Forbidden
405 Method not allowed (calling api with wrong method)
500 Internal error occurred while creating folder

 

 

Comments


6 Comments


Ryan D'Souza the API follows the same permissions as in the UI, if the user can see other users profile in Collaborate UI then they should be able to view the profile information using the API. Can you please let us know what issue are you facing.


To read people information such as phone number, picture url, bio text, what permission does the current user need to have?


Thanks for this Imran. I am getting a 403 Forbidden error now when I call the 'Add User' API. The same error occurs when I call 'Add Site'.


Shiva Kataksham I am afraid we do not have a search user by email function. If the intention of checking the user in the system is to create it, then I would just call the Add user API and if the user already exists then it will return you an error.


I am looking to find if a user already exists in Collaborate. How do I go about this? Is there a way to check if the user exists given a user's email address?

Last Updated: Jun 11,2023