Create Ticket My Tickets Post Discussion
Login  Sign up

GET Usergroup (Search)



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.


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:


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.

NameStringUser Group name to search for.

ExternalIdStringUser Group external ID to search for.

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.


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

Response Body

  "UserGroups": [
      "Name": "Testgroup",
      "UserIds": [
      "CompanyId": 6XXXX
  "TotalRows": 1

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.