GET 1.0/{InstanceId}/Groups

Gets a list of groups within ADM

Request Information

URI Parameters

API Parameter Details
NameDescriptionTypeAdditional information
InstanceId

The instance ID relating to a specific ADM database

string

Required

Body Parameters

None.

Response Information

Resource Description

A list of Groups

Collection of Group
API Parameter Details
NameDescriptionTypeAdditional information
Id

The ID of the group

integer

None.

Name

Name of the group

string

None.

Description

Description of the group

string

None.

InboxId

The Inbox ID of the group

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "InboxId": 4
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "Description": "sample string 3",
    "InboxId": 4
  }
]