ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Customer → Get Many for Current User

AI-generated

Summary

Retrieve a paginated list of customers accessible to the current user, optionally filtered by text search and sorted by a chosen property.

Inputs

  • pageSize — Maximum number of customer entities to return per page (minimum 1).
  • page — Zero‑based page index to retrieve.
  • sortOrder — Sort direction, either ASC or DESC.
  • customerTextSearch — Case‑insensitive substring filter on customer title.
  • customerSortProperty — Property of the customer entity to sort by (e.g., title, email, createdTime).

Output shape

array of Customer entities (paginated)

Returns a page of customer records; fields omitted if not set; subsequent pages accessed via increasing page number.

Examples

Example 1: Get the first page of all customers for the current user

resource=customer, operation=Get Many for Current User, pageSize=10, page=0, sortOrder=DESC, customerSortProperty=createdTime

Example 2: Search customers by title and sort by email descending

resource=customer, operation=Get Many for Current User, customerTextSearch=Alpha, customerSortProperty=email, sortOrder=DESC, pageSize=5, page=0

Example 3: Retrieve the second page of 20 customers sorted by creation date

resource=customer, operation=Get Many for Current User, pageSize=20, page=1, customerSortProperty=createdTime, sortOrder=ASC

Links

Discussion