GET Usergroup (Search)

GET Usergroup (Search)

TABLE OF CONTENTS



This API allows you to find all user groups matching the given parameters.


This API is available via SSL-secured HTTPS connection on the Cloud 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"

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.


NameTypeDescriptionRequired
NameStringUser Group name to search for.

ExternalIdStringUser Group external ID to search for.
PageNoInteger

The page number from which to start reading results (0 based).


PageSizeIntegerThe page size (number of rows) to return. The maximum allowable value is 250.
CompanyIdIntegerYour unique Company ID is found on the Organization Setup page of the secure website.✓
IntegrationKeyStringYour unique Integration Key is found on the Organization 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 the Postman API Platform.


The below example demonstrates how to find user groups using the GET Usergroup API call.


Request URL

https://eforms.mobileform.net:443/api/v2/usergroup/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
HTML

Response Body

{
  "UserGroups": [
    {
      "Id": "b42XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "Name": "Testgroup",
      "UserIds": [
        "c9bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      ],
      "CompanyId": 6XXXX
    }
  ],
  "TotalRows": 1
}



    • Related Articles

    • GET Folder (Search)

      The GET Folder (Search) API finds all folders 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 ...

    • GET Screen (Map Search)

      The GET Screen (Map Search) API returns the Published version of matching Map Screens or all versions of a single specified Map Screen. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query ...

    • GET Screen (Search)

      TABLE OF CONTENTS Parameters Example The Screen API returns the Published version of matching Forms or all versions of a specified Form. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query ...

    • GET Screen (Iconboard Search)

      TABLE OF CONTENTS Parameters Example The GET Screen (Iconboard Search) API returns the Published version of the matching Icon Boards or all versions of a specified Icon Board. On the Cloud, this API is available via SSL-secured HTTPS connection using ...

    • GET Companies (Company Search)

      TABLE OF CONTENTS GET Request GET Response Company Response Company Response Status Response Error API Usage Example To search for and retrieve multiple Companies at once, use a GET with the search API found at: /api/v2/company/search?format=xml/json ...