TABLE OF CONTENTS

  • Parameters
  • Example


ADDITIONAL INFO

  • API Explorer
  • General Information

 

 

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.

 

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. The maximum allowable value is 250.


CompanyId

Integer

Your unique Company ID is found on the Organization Setup page of the secure website.

✓

IntegrationKey

String

Your 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://secure.amplusforms.com:443/api/v2/usergroup/search?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Body

{

  "UserGroups": [

    {

      "Id": "b42XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

      "Name": "Testgroup",

      "UserIds": [

        "c9bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

      ],

      "CompanyId": 6XXXX

    }

  ],

  "TotalRows": 1

}