This API allows you to find all user groups 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/search?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/search | Model Description/Schema & Parameters |
Parameters
The GET Usergroup (Search) API allows you to find all user groups that match given parameters. The required and optional parameters for a GET call to the Usergroup (Search) API are outlined below.
| Name | Type | Description | Required |
|---|---|---|---|
| Name | String | User Group name to search for. | |
| ExternalId | String | User Group external ID to search for. | |
| PageNo | Integer | The page number from which to start reading results (0 based). | |
| PageSize | Integer | The page size (number of rows) to return. Maximum allowable value is 250. | |
| 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 find user groups using the GET Usergroup API call.
Request URL
https://eforms.mobileform.net/api/v2/usergroup/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXResponse Body
{
"UserGroups": [
{
"Id": "b42XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Testgroup",
"UserIds": [
"c9bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
],
"CompanyId": 6XXXX
}
],
"TotalRows": 1
}