GET v1/Groups/Search

Search for a group by name.

Request Information

Parameters

Name	Type	Description	Additional information
request	GroupSearchRequest	Container for the Group Search Request input parameters. See parameter details below.	Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property	Type	Description
Query	String	The name of the Group you would like to search for.
MaxResults	Int32	The maximum number of results to return. The upper limit is 100. This field is optional. The default is 10.
SdkVersion	String	If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "groups": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "organizationCount": 3
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "organizationCount": 3
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "organizationCount": 3
    }
  ],
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "query": "sample string 1",
    "maxResults": 2,
    "sdkVersion": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<GroupSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 3</SdkVersion>
    <MaxResults>2</MaxResults>
    <Query>sample string 1</Query>
  </Request>
  <Groups>
    <Group>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <OrganizationCount>3</OrganizationCount>
    </Group>
    <Group>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <OrganizationCount>3</OrganizationCount>
    </Group>
    <Group>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <OrganizationCount>3</OrganizationCount>
    </Group>
  </Groups>
</GroupSearchResponse>