GOgolioth
Devices

List devices in the project

Changed on

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

Request

  • Base URL
    https://api.golioth.io
  • URL
    https://api.golioth.io/v1/projects/{projectId}/devices
  • Auth
    API key in header x-api-key and API key in header Authorization

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

Changes

  • dbbf7fd3a346Revision changes
    • info

      added the new optional query request parameter cohortId

    • info

      added the optional property // to the response with the status

  • 1e1e047dcb23Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status