The GET User Details API allows you to retrieve user details matching the given parameters.
On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.
/api/v2/user?format=xml/json
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | api/v2/user | Model Description/Schema & Parameters |
Parameters
The GET verb on the User API allows you to retrieve all details of the user matching the provided parameters. The required and optional parameters for a GET call to the User API are outlined below:
| Name | Type | Description | Required |
|---|---|---|---|
| Id | String | The user’s unique identified. This value must be a GUID and can be obtained from the User Search API. | ✓ |
| CompanyId | Integer | Your unique Company Id found on the Organisation Setup page of the secure website. | ✓ |
| IntegrationKey | String | Your unique Integration Key found on the Organisation Setup page of the secure website. | ✓ |
Example
Given that the API is REST-based, you can access it directly via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.
Request URL
https://eforms.mobileform.net/api/v2/user/search?CompanyId=XXXXX&IntegrationKey=78eec3XXXXXXXXXXXXXXXXX&&Email=XXXmctesty%40example.comVendor accounts using Full Access API Integration Keys retrieve UserID and Id. All other accounts/keys retrieve Id.
Response Body
{
"Users": [
{
"Id": "2ebc64a36a0d400XXXXXXXXXXXXX",
"UserID", 436055,
"Type": "Premium",
"FirstName": "Mc",
"LastName": "Testy",
"Email": "XXXmctesty@example.com",
"Status": "Active",
"ExternalId": "XXX",
"TimeZone": "Universal Standard Time",
"TimeZoneOffSet": 120,
"Country": "BA",
"WebsiteRole": "ReadOnly",
"CreatedDate": "2019-09-11T06:24:03.9630000Z",
"LastUpdated": "2022-03-19T13:50:51.8770000Z",
"LastActivity": "2021-08-30T06:28:58.1000000Z",
"UserDevices": [
{
"Id": "77f3a44b82264f7fXXXXXXXXX",
"OS": "Windows",
"OSVersion": "6.2.9200.0",
"Hardware": "Microsoft Corporation Surface Laptop 2",
"AppVersion": "2.19.5.786",
"LastActivityDate": "2021-08-30T06:28:57Z"
}
],
"UserAudits": [
{
"Id": 16XXXX,
"Email": "XXXmctesty@example.com",
"On": "2019-09-11T06:26:40.6428186Z",
"Type": "Premium",
"Status": "Active"
},
{
"Id": 16XXXX,
"Email": "XXXmctesty@example.com",
"On": "2019-09-11T06:23:58.9630000Z",
"Off": "2019-09-11T06:26:40.6428186Z",
"OffReason": "Activated",
"Type": "Full",
"Status": "Invited"
}
],
"Folders": [],
"Groups": [
"f3e6d6e571924a2XXXXXXXXXX"
],
"Metadata": [
{
"Key": "NameEUI"
}
],
"CompanyId": XXXXX
}
],
"TotalRows": 1
}