GET groups?rpp={rpp}&page={page}&include={include}

Gets a list of groups. [OData]

Request Information

URI Parameters

NameDescriptionTypeAdditional information
rpp

Results per page.

integer

Default value is 0

page

Current page number.

integer

Default value is 0

include

Defines the properties to be included (separated by comma).

string

None.

Body Parameters

None.

Response Information

Resource Description

GenericPaginatedListViewModelOfGroupViewModel
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Pagination

PaginationParameterModel

None.

Items

Collection of GroupViewModel

None.

NextPageUrl

string

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "pagination": null,
  "items": [
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "type": {
        "name": "sample string 1",
        "displayName": "sample string 2",
        "selfUrl": "sample string 3"
      },
      "chief": {
        "selfUrl": "sample string 1"
      },
      "users": null,
      "selfUrl": "sample string 4"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "description": "sample string 3",
      "type": {
        "name": "sample string 1",
        "displayName": "sample string 2",
        "selfUrl": "sample string 3"
      },
      "chief": {
        "selfUrl": "sample string 1"
      },
      "users": null,
      "selfUrl": "sample string 4"
    }
  ],
  "nextPageUrl": "sample string 2"
}