Skip to content

Get device group information
Stable

Request

Retrieves full details for a single device group by its UUID.

Use this endpoint to fetch group metadata — including name, device count, child group count, hierarchy path, and associated blueprint — when you have a specific group_id and need its current state rather than a paginated list. About Get Device Group Information Device groups in Esper are hierarchical collections of devices used to organize and apply policies at scale. Each group can have a parent group, child groups, and an associated blueprint that defines the configuration applied to devices in that group. This endpoint returns a snapshot of a single group's metadata and is commonly used to validate group structure before performing bulk operations or blueprint assignments. To retrieve a group_id, use the List Device Groups endpoint first.

Key Fields

id — The group's UUID; use this as group_id in subsequent group-scoped requests path — The full hierarchy path of the group within the enterprise's group tree parent — URL reference to the parent group, if the group is nested device_count — Number of devices directly in this group children_count — Number of child groups nested under this group blueprint — URL reference to the blueprint currently associated with this group

Common Use Cases

Confirm a group exists and retrieve its metadata before applying a blueprint or running a pipeline Inspect a group's position in the hierarchy (path, parent) when managing nested group structures Verify device_count before initiating bulk device operations against a group

Best Practices

Use List Device Groups to discover group_id values; avoid hardcoding UUIDs across environments Check children_count before deleting a group — child groups must be removed first, and groups containing devices cannot be deleted until devices are moved or removed Cache group metadata conservatively; group structure can change as devices are enrolled or moved

Workflow

  1. Call List Device Groups (GET /enterprise/{enterprise_id}/devicegroup/) to find the target group and retrieve its group_id
  2. Call this endpoint with the group_id to fetch full group details
  3. Use the returned blueprint, path, and device_count to inform downstream operations such as blueprint updates, pipeline targeting, or group deletion
Security
esper_cloud_api_apiKey
Path
group_idstring, (uuid)required

A UUID string identifying this enterprise device group.

enterprise_idstringrequired

A UUID string identifying enterprise.

cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/enterprise/{enterprise_id}/devicegroup/{group_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
idstring, (uuid)(Id)read-only

Group id

namestring(Name)required

Group name

created_onstring, (date-time)(Created on)read-only

Date and time of when the group was created

enterprisestring, (url)(Enterprise)read-only

Enterprise url

parentstring, (url)(Parent)

Parent group url

device_countinteger(Device count)read-only

Count of devices in the group

pathstring(Path)read-only

Path of the group

children_countinteger(Children count)read-only

Count of child groups

thumbnailstring, (uuid)(thumbnail)

thumbnail associated with the group

blueprintstring, (uuid)(Blueprint)read-only

Blueprint associated with the group.

Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "created_on": "2019-08-24T14:15:22Z", "enterprise": "string", "parent": "string", "device_count": 0, "path": "string", "children_count": 0, "thumbnail": "dec11f24-4767-4257-ac7d-bde137bc173e", "blueprint": "f63e6a96-31ed-4c31-b384-a8046257f34c" }