User resource

Get user - Get user v2

OVERVIEW

Get a user from Collaborate

This API call is used to retrieve a user from the system.

User information can be retrieved by providing either the user id Or user's email address

Request

1. Get user by userId : GET    /users/{userid}

2. Get user by email :  GET    /users/{email}?type=email

        

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 the wrong method)
500 Internal error occurred

 

 

Comments


1 Comments


Is there a way to get the sites a user has access to?

Apparently the only way to know is to get all the users for a site, but this may be too inefficient where you have a large number of sites.

 

Last Updated: Jun 11,2023