Skip to content

Query All Entities

GET
/v1/entities
curl --request GET \
--url https://example.com/api/v1/entities \
--header 'Authorization: <Authorization>'
q
string

Search string; matches names, descriptions, serial/model numbers, manufacturers, notes, purchase sources, tag names, and custom field values. Use # to look up by asset ID and double quotes for exact phrases

page
integer

Page number

pageSize
integer

Items per page

tags
Array<string>

Tags Ids

matchAllTags
boolean

Require all selected tags to match (AND) instead of any (OR)

parentIds
Array<string>

Parent Ids

entityTypeIds
Array<string>

Entity type IDs; when provided this filter takes precedence over isLocation

orderBy
string

Field to order by; valid values: name, createdAt, updatedAt, assetId

orderDirection
string

Order direction; valid values: asc, desc. Defaults to desc for createdAt and updatedAt, asc otherwise

OK

Media typeapplication/json
object
items
Array<object>
object
archived
boolean
assetId
string
createdAt
string
description
string
entityType
object
createdAt
string
defaultTemplate
object
createdAt
string
description
string
id
string
name
string
updatedAt
string
defaultTemplateId
string
description
string
icon
string
id
string
isLocation
boolean
name
string
updatedAt
string
id
string
imageId
string
nullable
insured
boolean
itemCount

Container-specific (populated when querying locations)

number
name
string
parent

Edges

object
object recursive
purchasePrice
number
quantity
number
soldDate

Sale details

string
tags
Array<object>
object
color
string
createdAt
string
description
string
icon
string
id
string
name
string
parentId
string
nullable
updatedAt
string
thumbnailId
string
nullable
updatedAt
string
page
integer
pageSize
integer
total
integer
totalPrice
number
Example
{
"items": [
{
"assetId": "0"
}
]
}