ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Device → Get Many by Entity Group

AI-generated

Summary

Fetch a paginated list of devices belonging to a given Entity Group ID.

Inputs

  • entityGroupId (required) — Identifier of the Entity Group whose devices are to be retrieved.
  • pageSize — Maximum number of devices returned per page (default 10, minimum 1).
  • page — Zero‑based page index (default 0).
  • sortOrder — Sort direction, either "ASC" or "DESC" (default "DESC").
  • deviceSortProperty — Property used for sorting, such as "name" or "createdTime" (default "createdTime").
  • deviceTextSearch — Case‑insensitive substring to filter device names.

Output shape

a list of device entities (paginated results)

Response includes the devices array; pagination metadata (total, page, pageSize) may be present depending on ThingsBoard version.

Examples

Example 1: Retrieve first page of devices for group ID 784f394c-42b6-435a-983c-b7beff2784f9, 5 per page, sorted by name descending.

pageSize=5, page=0, sortOrder=DESC, deviceSortProperty=name, entityGroupId=784f394c-42b6-435a-983c-b7beff2784f9

Example 2: Search for devices named "sensor" within group ID 123e4567‑e89b‑12d3‑a456‑426614174000, returning up to 20 items.

pageSize=20, page=0, deviceTextSearch=sensor, entityGroupId=123e4567-e89b-12d3-a456-426614174000

Example 3: Paginate through devices of group ID abcdef12‑3456‑7890‑abcd‑ef1234567890, page 1, page size 10.

pageSize=10, page=1, entityGroupId=abcdef12-3456-7890-abcd-ef1234567890

Links

Discussion