ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Entity Group → Get by Owner/Name/Type

AI-generated

Summary

Retrieves a specific ThingsBoard entity group by owner, name, and type.

Inputs

  • authentication — Authentication method (API Key or Username/Password). Defaults to API Key.
  • groupType (required) — Entity group type (e.g., DEVICE, CUSTOMER, ASSET, DASHBOARD, EDGE, ENTITY_VIEW, USER).
  • ownerType (required) — Owner entity type (e.g., TENANT, CUSTOMER).
  • ownerId (required) — A string value representing the Owner ID.
  • groupName (required) — Entity Group name.

Output shape

a single record

Returns the full entity group JSON object.

Examples

Example 1: Fetch a DEVICE entity group named 'My Devices' owned by a CUSTOMER with ID 'abc123'.

groupType: DEVICE, ownerType: CUSTOMER, ownerId: abc123, groupName: My Devices

Example 2: Retrieve a CUSTOMER entity group named 'Beta Customers' owned by the TENANT.

groupType: CUSTOMER, ownerType: TENANT, ownerId: , groupName: Beta Customers

Links

Discussion