Skip to main content
GET
List devices

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page
number
default:1

Page number

Required range: x >= 1
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
sortBy
enum<string>
default:created_at

Field to sort by

Available options:
name,
created_at,
updated_at,
last_seen,
status
sortDesc
boolean | null
default:true

Sort descending

Search by name, serial number, MAC, or IP

Maximum string length: 255
companyId
string<uuid>

Filter by company ID

deviceTypeId
string<uuid>

Filter by device type ID

locationId
string<uuid>

Filter by location ID

status
string

Filter by status

Maximum string length: 100
manufacturer
string

Filter by manufacturer

Maximum string length: 100
integrationSource
string

Filter by integration source

Maximum string length: 100

Response

List of devices

data
object[]
required

Array of devices

pagination
object
required