v1

latestOpenAPI 3.0.32026-07-13153243440.8 KB
Devices

List devices in the project

List devices in the project, optionally applying filters and pagination parameters.

Devices can be filtered by any property, and additionally filtered by a freetext search term.

get/v1/projects/{projectId}/devices

Path parameters

projectIdstring required

Project ID

Query parameters

pageinteger

Pagination page number

perPageinteger

Pagination items per page. Must be between 1 and 100 (inclusive). Default is 100.

deviceNamestring

Filter by device name (full match)

hardwareIdstring

Filter by hardware ID (full match)

tagsstring[]

Filter by tag IDs. Devices must have all specified tags.

blueprintIdstring

Filter by blueprint ID

statePathstring

Path to device state to include in the response

streamPathstring

Path to device stream data to include in the response

updatePathstring

Ignored, kept for backward compatibility

termstring

Partial text search term to filter devices by name or hardware IDs

enabledboolean

Filter by enabled status

cohortIdstring

Filter by cohort ID

Response

A successful response.

pageinteger
perPageinteger
totalinteger