API Documentation
Set Admin Credentials...
Users GET

get

Users GET

Using the internal Syncplicity company ID represented as a Guid, the API can retrieve all the defined users associated with the specified Company. Guid must be associated with a company that the application has authorization to access.
Required Scope: Users, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • COMPANY_GUID
    string
    Unique ID associated with the company.
    Related Information: The Company ID (Guid) is obtained as part of the JSON response from the initial OAuth connection

Resource URL

https://api.syncplicity.com/ provisioning/company_users.svc/company/{COMPANY_GUID}/users

Query Parameters

Name Values Description
lastUserGuid

Used for paginated mode. Put here the last user guid from previous set in order to get next set of users
limit

Maximum number of users to be returned.

Header Parameters

Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Request Body

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...
Reset
Request Response cURL

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

	

	
	

		
Response Payload Schema

		
	
		
	





Response Error Details


    
    
  • 
        
    HTTP Code
    
        
    Error Code
    
        
    Description
    
    
    • 
    
    
  • 
        
    
            403
        
    
        
    
            403
        
    
        
    
            
    
                (Forbidden) - Not This Company User
            
    
        
    
    
    • 
    
    
  • 
        
    
            404
        
    
        
    
            404
        
    
        
    
            
    
                (Not Found) - Unknown Company ID
    (Not Found) - Wrong Company ID
            
    
        
    
    
    • 
    











    
Working...