Skip to main content
GET
List assets

Authorizations

Authorization
string
header
required

Organization API key with an sk_live_ or sk_test_ prefix

Query Parameters

limit
integer
default:20

Maximum number of items to return from a Canary-native list (1-100)

Required range: 1 <= x <= 100
cursor
string

Pagination cursor from previous response

direction
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
asset_type
string

Filter by a current asset type slug, including custom types or unassigned Compatibility slug derived from current active asset type assignments. Returns unassigned when prior assignments exist but none remain active.

Maximum string length: 100
status
enum<string>

Filter by status

Available options:
online,
offline,
not_monitored
criticality
enum<string>

Filter by operational criticality

Available options:
critical,
important,
normal
location_id
string

Filter by location ID

Response

List of assets

data
object[]
required
meta
object
required