ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Customer → Get Many by Entity Group

AI-generated

Summary

Retrieves a paged list of Customer entities belonging to a specified Entity Group.

Inputs

  • authentication — Authentication method (API Key or Username/Password).
  • pageSize — Maximum number of customers to return per page (minimum 1).
  • page — Zero‑based page index for pagination.
  • sortOrder — Sort order for results, either ASC or DESC.
  • customerTextSearch — Case‑insensitive substring filter on customer title.
  • customerSortProperty — Property of the customer to sort by (e.g., Title, Email, Country).
  • entityGroupId (required) — Identifier of the entity group whose customers to retrieve.

Output shape

array of Customer objects

Pagination metadata (page, pageSize) may be included; optional filters and sorting are applied; the response contains the matching customer records.

Examples

Example 1: Fetch the first page of customers for entity group ID 784f394c-42b6-435a-983c-b7beff2784f9, returning up to 10 records sorted by createdTime descending.

resource=customer, operation=Get Many by Entity Group, entityGroupId=784f394c-42b6-435a-983c-b7beff2784f9, pageSize=10, page=0, sortOrder=DESC, customerSortProperty=createdTime

Example 2: Search for customers in a specific entity group using a text filter and custom sort.

entityGroupId=123e4567-e89b-12d3-a456-426614174000, customerTextSearch=Acme, pageSize=5, page=1, sortOrder=ASC, customerSortProperty=title

Example 3: Retrieve all customers of an entity group without pagination limits for further processing.

entityGroupId=999e4567-e89b-12d3-a456-426614174001, pageSize=1000, page=0, sortOrder=DESC

Links

Discussion