Search Knowledge Base by Keyword
GET User (User Search)
The Users API allows you to retrieve, create and delete Users on the platform. This enables scenarios, where users created/maintained in other systems (e.g. SAP, Salesforce), can be replicated through the platform automatically.
Note: This API endpoint implements pagination, and as such, you must cater for this when you connect to our platform.
You can learn more about pagination in our API overview.
CONTENTS
GET Request
The GET verb allows you to retrieve multiple or a single User identified by name, email or an external ID.
The required (numbered) and optional parameters for a GET call to the User Search API are outlined below.
By default, all paginated APIs start at PageNo of 0, which is the first page (i.e. the slice) of the result set.
After clicking “Try it out!” the GET Request URL will display for integration use in your systems.
Also, the Response Body, Code and Headers will be visible in the Response Content Type specified (JSON/XML).
GET Response
The data returned from a User GET is provided as follows:
API Usage Example
Given that the API is REST-based, you can access the API directly via your web browser to test it. Obviously, for actual integration work, you will need to make a web request to the given REST URL and then parse the response.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET, POST and DELETE verbs.
The format query string parameter controls the desired response format. Specify either XML or JSON.
To search for and retrieve multiple Users at once, use a GET with the search API found at:
/api/v2/user/search?format=xml/json
Below is a simple GET example which gets a User using XML format.
GET Request
/api/v2/user?email=test@somewhere.com&integrationkey=xxxxxxxxxxxx&companyid=1&format=xml
XML Response
<UserResponse>
<ResponseStatus>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
</ResponseError>
</Errors>
</ResponseStatus>
<User>
<CompanyId>0</CompanyId>
<Email>String</Email>
<ExternalId>String</ExternalId>
<FirstName>String</FirstName>
<Folders>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Folders>
<Groups>
<Id>00000000-0000-0000-0000-000000000000</Id>
</Groups>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IntegrationKey>String</IntegrationKey>
<LastActivity>0001-01-01T00:00:00</LastActivity>
<LastName>String</LastName>
<UserDevices>
<UserDevice>
<Hardware>String</Hardware>
<Id>00000000-0000-0000-0000-000000000000</Id>
<OS>String</OS>
<OSVersion>String</OSVersion>
</UserDevice>
</UserDevices>
<Status>String</Status>
<WebsiteRole>String</WebsiteRole>
</User>
</UserResponse>