Device Groups
Download the specification.
Device Groups provide a way to organize and manage devices within a project. Each group represents a subset of the project’s registered devices, and a device may belong to multiple groups in the same project. Beyond simple grouping, a Device Group also defines the project’s “processing plan” for incoming device data—known as a flow in the Things Manager. A flow brings together four elements: the devices it applies to, the decoders used to interpret their uplinks, encoders used to encode downlinks, and the destinations where decoded messages are forwarded.
At present, the Device Groups API focuses on device membership, allowing you to add or remove devices from a group. Configuration of flows themselves—such as managing decoders, encoders, or destinations—remains available through the Things Manager web interface.
Retrieve all device groups that match the query parameters given. If a search parameter is provided, device groups whose name or description (partially) match are returned.
String that encodes all necessary information to retrieve a page.
Limit the number of results (per page).
50Sorting fields separated by comma. Default order is Ascending (ASC), minus(-) should be used in front of field name for Descending (DESC) order.
createdAt,-nameInclude only device groups whose names or descriptions contain the search term. Matching is done case-insensitively.
Include only device groups owned by the client with the provided clientId. If clientId is omitted, all device groups are included that are accessible to the caller.
Include only device groups associated with the project with the provided projectId. If projectId is omitted, all device groups are included that are accessible to the caller.
Include only device groups created before the provided date and time. The date-time must be in ISO 8601 format.
Include only device groups created at or after the provided date and time. The date-time must be in ISO 8601 format.
Include only device groups modified before the provided date and time. The date-time must be in ISO 8601 format.
Include only device groups modified at or after the provided date and time. The date-time must be in ISO 8601 format.
A list of device groups matching the search criteria.
A paginated list of device groups
A list of device groups matching the search criteria.
No content
A group of devices.
The unique identifier of the device group.
36e75427-4c6e-438c-89b5-0cbdb0d4068cThe name of the device group.
Parking sensors device groupA description of the device group.
This is a group of devices containing parking sensor devices.The project identifier to which this device group belongs.
12345678-1234-1234-1234-123456789012The timestamp when the device group is created in the system.
2025-07-01T23:00:00.000ZThe user who created the device group.
principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4The timestamp when the device group is last modified in the system.
2025-07-01T23:00:00.000ZThe user who last modified the device group.
principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4Device group has been created successfully.
Device group has been created successfully.
No content
Retrieve a device group by its ID. The device group must be accessible to the caller.
The ID of the device group to retrieve.
The requested device group.
The requested device group.
No content
The ID of the device group to update.
A group of devices.
The unique identifier of the device group.
36e75427-4c6e-438c-89b5-0cbdb0d4068cThe name of the device group.
Parking sensors device groupA description of the device group.
This is a group of devices containing parking sensor devices.The project identifier to which this device group belongs.
12345678-1234-1234-1234-123456789012The timestamp when the device group is created in the system.
2025-07-01T23:00:00.000ZThe user who created the device group.
principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4The timestamp when the device group is last modified in the system.
2025-07-01T23:00:00.000ZThe user who last modified the device group.
principal/9ebbb3b1-1b6b-46e7-8d58-bb8fe7ae24d4Device group has been updated successfully.
Device group has been updated successfully.
No content
The ID of the device group to delete.
Device group has been deleted successfully.
Device group has been deleted successfully.
No content
Retrieve all devices linked to a device group. The device group must be accessible to the caller.
The ID of the device group for which to retrieve linked devices.
Include only links created before the provided date and time. The date-time must be in ISO 8601 format.
Include only links created at or after the provided date and time. The date-time must be in ISO 8601 format.
String that encodes all necessary information to retrieve a page.
Limit the number of results (per page).
50Sorting fields separated by comma. Default order is Ascending (ASC), minus(-) should be used in front of field name for Descending (DESC) order.
createdAt,-namePage of devices linked to the specified device group.
A paginated list of device group to device links
Page of devices linked to the specified device group.
No content
The ID of the device group for which to retrieve linked devices.
A link between a device group and a device.
The identifier of the device group.
aacaf415-a800-4adb-9258-3e3b671d6492The identifier of the device.
11122598-fa9e-4262-a6c9-a0a34c885c86The timestamp when the device link was created in the system.
2025-07-01T23:00:00.000ZThe user who created the device link.
principal/fe288bc5-8652-4ecc-806b-7cf0c7db085eDevice has been linked to the device group successfully.
Device has been linked to the device group successfully.
No content
The ID of the device group to unlink the device from.
The ID of the device to unlink from the device group.
Device has been unlinked from the device group successfully.
Device has been unlinked from the device group successfully.
No content
Last updated
Was this helpful?
