GET api/InternalGroups/GetInternalGroups?pageIndex={pageIndex}&pageSize={pageSize}

Gets a list of all Internal groups. Pagination is supported.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageIndex	Optional page index (default is 0).	integer	None.
pageSize	Optional page size (default is 200).	integer	None.

Body Parameters

None.

Response Information

Resource Description

GetInternalGroupsResult

Name	Description	Type	Additional information
PagedEvents	A page with internal group rows.	InternalGroupRow	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedEvents": {
    "PageIndex": 1,
    "PageSize": 2,
    "TotalItems": 3,
    "TotalPages": 4,
    "Items": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "Description": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetInternalGroupsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedEvents>
    <Items>
      <GetInternalGroupsResult.InternalGroupRow>
        <Description>sample string 3</Description>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </GetInternalGroupsResult.InternalGroupRow>
      <GetInternalGroupsResult.InternalGroupRow>
        <Description>sample string 3</Description>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </GetInternalGroupsResult.InternalGroupRow>
    </Items>
    <PageIndex>1</PageIndex>
    <PageSize>2</PageSize>
    <TotalItems>3</TotalItems>
    <TotalPages>4</TotalPages>
  </PagedEvents>
</GetInternalGroupsResult>