ThingsBoardInstall

Summary

Fetch a page of devices matching optional filters and sort order.

Inputs

• authentication — Authentication method: API Key or Username/Password.
• pageSize — Maximum number of entities per page (default 10, min 1).
• page — Zero‑based page index (default 0).
• sortOrder — Sort direction, ASC or DESC (default DESC).
• deviceSortProperty — Property to sort by, e.g., name, createdTime, type (default createdTime).
• deviceTextSearch — Case‑insensitive substring filter on device name (default empty).
• deviceType — Filter by device type name (default empty).

Output shape

a page of device objects

Returns up to pageSize devices; pagination via page; optional filters and sorting apply; no additional metadata is returned.

Examples

Example 1: Retrieve first page of all devices sorted by name descending

page=0, pageSize=10, sortOrder=DESC, deviceSortProperty=name, deviceTextSearch=

Example 2: Get devices of a specific type owned by a customer

deviceType=MyType, customerIdRequired=123, pageSize=5, page=1

Example 3: Paginated fetch with custom page size

pageSize=20, page=2, sortOrder=ASC, deviceSortProperty=createdTime

Links

• n8n community nodes installation guide