This API returns details of the user group 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/usergroup?format=xml/json
You may use either JSON or XML formats in your GET request.
You indicate this by setting the ContentType HTTP header as “application/json” or “application/xml”.
If no ContentType is specified, XML format is assumed.
All XML formatted requests must specify the following XML namespace in the data source root element: xmlns:i=”http://www.w3.org/2001/XMLSchema-instance”
Endpoints & API Explorer
| Node | API Endpoint | API Explorer |
|---|---|---|
| US | api/v2/usergroup | Model Description/Schema & Parameters |
Parameters
The GET Usergroup API lets you get details of a specified user group.
The required and optional parameters for a GET call to the Usergroup API are outlined below.
| Name | Type | Description | Required |
|---|---|---|---|
| Id | Integer | The Group’s unique identifier. | ✓ |
| 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 the API directly via your web browser to test or by using Postman API Platform.
The below example demonstrates how to return details of a specified user group using the GET Usergroup API call.
Request URL
https://eforms.mobileform.net/api/v2/usergroup?Id=b42XXXXXXXXXXXXXXXXXXXXXXXXXX&CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXResponse Body
{
"UserGroup": {
"Id": "b42XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Testgroup",
"UserIds": [
"c9bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
],
"CompanyId": 6XXXX
}
}