Filter

post

https://api.formant.io/v1/admin/devices/filter

Query devices by name and/or tags Resource: devices Authorized roles: viewer

Body Params

DeviceQuery

externalId

string

Query devices by external ID.

name

string

Query devices by name.

query

string

Query partial device names with wildcard *.

organizationId

string

Query devices by organization ID.

tags

array of objects

Query devices by tags.

MultiTagSets

fleetId

uuid | null

Query devices by fleet ID.

enabled

boolean

Query devices by enabled status.

fullyConfigured

boolean

Query devices by configured status.

type

string

enum

Query devices by device type.

Allowed:

count

number

0 to 1000

Limit the number of devices returned by this query (max 1000).

offset

number

0 to 9007199254740991

Paginate the results by specifying an offset.

createdAfter

date-time

Query devices created after this date.

disabledBefore

date-time

Query devices disabled (deleted) before this date.

online

boolean

Query online devices.

fillOnlineStatus

boolean

Include device online status in the response.

fillLastSeen

boolean

Include last seen timestamp in the response.

sort

array of objects

length ≤ 2

Sort order for the query results.

sort

hasExternalId

boolean

Query devices that have an externalId.

Response

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200