Skip to main content

Gets a device group by name

GET /v1/devicegroup

Summary​

Gets a device group by name.

Details​

Request body: JSON object containing the device group name.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

Required: Yes

application/json​

  • value (string, optional)

Example

{
  "value": "Example value"
}

Responses​

200​

Success

application/json​

  • key (integer (int64), optional)
  • collectionName (string, optional)
  • description (string, optional)
  • itemTypeID (integer (int64), optional)
  • itemID (integer (int64), optional)
  • parentID (integer (int64), optional)
  • creationDate (string (date-time), optional)

Example

{
  "key": 1,
  "collectionName": "Example value",
  "description": "Example description",
  "itemTypeID": 1,
  "itemID": 1,
  "parentID": 1,
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}