GET api/groups?nameFilter={nameFilter}&tag={tag}&active={active}

Returns a list of Groups

Request Information

URI Parameters

NameDescriptionTypeAdditional information
nameFilter

Only groups that contain this value in their name will be returned

string

Default value is

tag

Limit results to groups that have this specific tag

string

Default value is

active

string

Default value is

Body Parameters

None.

Response Information

Resource Description

List of Groups

Collection of ViewGroupDTO
NameDescriptionTypeAdditional information
id

Unique Group ID

integer

None.

name

Group Name

string

None.

description

Group description

string

None.

tags

Group tags, comma seperated list of tags

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "tags": "sample string 4"
  },
  {
    "id": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "tags": "sample string 4"
  }
]