ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Customer → Get Many

AI-generated

Summary

Fetch a paginated list of customers, optionally filtered and sorted.

Inputs

  • authentication (required) — Method of authenticating with ThingsBoard (API Key or Username/Password).
  • pageSize — Maximum number of customer records to return per page (default 10).
  • page — Zero‑based page index (default 0).
  • sortOrder — Sort direction, either ASC or DESC (default DESC).
  • customerTextSearch — Case‑insensitive substring to filter customers by title.
  • customerSortProperty — Property used for sorting, such as Title, City, etc. (default createdTime).

Output shape

a paginated array of customer objects

Each item contains customer fields like id, title, createdTime, etc.; pagination is controlled by page and pageSize parameters.

Examples

Example 1: Retrieve the first page of customers sorted by creation date descending

Authentication: API Key; Page Size: 10; Page: 0; Sort Order: DESC; Customer Sort Property: createdTime

Example 2: Search customers containing 'Acme' in the title and return the second page

Authentication: API Key; Page Size: 5; Page: 1; Customer Text Search: Acme

Example 3: Get customers sorted by title in ascending order with a larger page size

Authentication: Username / Password; Page Size: 25; Sort Order: ASC; Customer Sort Property: title

Links

Discussion