Asset Endpoints

Assets & Devices

Device

GET /Asset — List Devices

Returns multiple Device records. Requires authentication.

Query Parameters

Name	Type	Description
activeinactive	string	Filter on active/inactive assets — comma-separated, first value true/false for active, second for inactive.
advanced_search	string	Advanced search string.
assetgroup_id	integer	Filter by assets belonging to a particular asset group.
assetgroups	string	Filter assets on asset groups — comma-separated IDs.
assets	string	Filter by specific asset IDs.
assetstatuses	string	Filter assets on asset statuses — comma-separated IDs.
assettype	integer	Filter by asset type (numeric).
assettype_id	integer	Filter by assets belonging to a particular asset type.
assettypes	string	Filter assets on asset types — comma-separated IDs.
bookmarked	boolean	Include only bookmarked assets in the response.
client_id	integer	Filter by assets belonging to a particular client.
client_ids	string	Returns assets based on client IDs — comma-separated.
columns_id	integer	The column profile ID.
consignable	boolean	Include only consignable assets.
consignment_id	integer	Filter by assets consignment ID.
contract_id	integer	Filter by assets assigned to a particular contract.
contract_id_adding_to	integer	Include the billing period of the linked contract in the response.
count	integer	Number of assets to return.
domotzagents	boolean	Include only assets with a linked Domotz agent.
excludethese	string	Exclude specific asset IDs — comma-separated.
globalSearchID	string	Global search ID.
idonly	boolean	Include only the asset ID in the response.
includeactive	boolean	Include active assets in the response.
includeallowedstatus	boolean	Include the asset column tallowallstatus in the response.
includeassetfields	boolean	Include asset fields — must also specify assettype_id.
includechildren	boolean	Include child assets in the response.
includecolumns	boolean	Include column details in the response.
includeinactive	boolean	Include inactive assets in the response.
includeservices	boolean	Include assets' linked service IDs in the response.
includeuser	boolean	Include user details in the response.
integration_tenantids	array[integer]	Filter by integration tenant IDs.
integration_type	string	Filter by integration source: aterarmm, ninjarmm, syncromsp, domotz, connectwiseautomate, snow, datto, passportal, addigy, liongard.
inventory_number	string	Filter by inventory number.
islogonbehalfview	boolean	Log-on-behalf view flag.
item_id	integer	Filter by assets item ID.
itemstock_id	integer	Filter by assets item stock ID.
kb_id	integer	Filter by knowledge base article ID.
lastupdatefromdate	boolean	Include the lastupdatefromdate field in the response.
lastupdatetodate	boolean	Include the lastupdatetodate field in the response.
licence_id	integer	Filter by assets assigned to a particular licence.
linked_to_ticket	boolean	Filter assets linked to a ticket.
linkedto_id	integer	Filter by assets linked to a particular asset.
mine	boolean	Include only assets that belong to yourself.
mysite	boolean	Include only assets belonging to your site.
noicon	boolean	Exclude the asset icon from the response.
order	string	Field name to order by (first).
order2	string	Field name to order by (second).
order3	string	Field name to order by (third).
order4	string	Field name to order by (fourth).
order5	string	Field name to order by (fifth).
orderdesc	boolean	Order ascending or descending on first sort field.
orderdesc2	boolean	Order ascending or descending on second sort field.
orderdesc3	boolean	Order ascending or descending on third sort field.
orderdesc4	boolean	Order ascending or descending on fourth sort field.
orderdesc5	boolean	Order ascending or descending on fifth sort field.
page_no	integer	Page number when using pagination.
page_size	integer	Page size when using pagination.
pageinate	boolean	Whether to use pagination in the response.
previously_selected	boolean	Include the most recent dateoccured from a linked ticket.
previously_selected_client_id	integer	Filter previously_selected by client ID.
previously_selected_site_id	integer	Filter previously_selected by site ID.
previously_selected_user_id	integer	Filter previously_selected by user ID.
salesorder_id	integer	Filter by assets sales order ID.
salesorder_line	integer	Filter by assets sales order line ID.
search	string	Filter response based on a search string.
search_inventory_number_only	boolean	Search only on inventory number.
service_id	integer	Filter by assets belonging to a particular service.
service_ids	string	Filter assets on service IDs — comma-separated.
site_id	integer	Filter by assets belonging to a particular site.
stockbin_id	integer	Filter by stock bin ID.
stockbin_ids	array[integer]	Filter by multiple stock bin IDs.
supplier_contract_id	integer	Filter by assets assigned to a particular supplier contract.
supplier_id	integer	Filter by assets belonging to a particular supplier.
suppliercontracts	string	Filter assets on supplier contracts — comma-separated IDs.
ticket_id	integer	Filter by assets belonging to a particular ticket.
tickettype_id	integer	Filter by ticket type ID.
user_id	integer	Filter by user ID.
username	string	Filter by the specified username.
include_custom_fields	string	Comma-separated list of custom field IDs to include in the response.

Response: 200 OK — Returns Device_View schema.

---

POST /Asset — Create Device(s)

Creates one or more Device records.

Request Body — Array of Device objects (JSON).

Response: 201 Created — Returns the created Device object.

---

GET /Asset/{id} — Get One Device

Returns a single Device by ID. Requires authentication.

Path Parameters

Name	Type	Required	Description
id	integer	Yes	Asset ID.

Query Parameters

Name	Type	Description
assettype_id	integer	Asset type ID filter.
includeactivity	boolean	Include activity details in the response.
includeallowedstatus	boolean	Include allowed status details in the response.
includedetails	boolean	Include extra objects in the response.
includediagramdetails	boolean	Include diagram details in the response.
includehierarchy	boolean	Include hierarchy details in the response.

Response: 200 OK — Returns a Device object.

---

DELETE /Asset/{id} — Delete Device

Deletes the device with the given ID.

Path Parameters

Name	Type	Required	Description
id	integer	Yes	Asset ID.

Response: 200 OK

---

GET /Asset/NextTag — Get Next Asset Tag

Returns the next available asset tag value.

Response: 200 OK — Returns a dynamic object.

---

GET /Asset/GetAllSoftwareVersions — Get All Software Versions

Returns all software versions across assets.

Response: 200 OK

---

DeviceApplications

GET /AssetSoftware — List Device Applications

Returns multiple DeviceApplications records. Requires authentication.

Query Parameters

Name	Type	Description
device_id	integer	Filter by device ID.
licence_id	integer	Filter by licence ID.
third_party_field	string	Third-party field name.
third_party_id	string	Third-party identifier.
user_id	integer	Filter by user ID.

Response: 200 OK

---

DeviceChange

GET /AssetChange — List Device Changes

Returns multiple DeviceChange records. Requires authentication.

Query Parameters

Name	Type	Description
asset_id	integer	Filter by asset ID.
count	integer	Number of records to return.
idonly	boolean	Return only IDs.
licence_id	integer	Filter by licence ID.
order / order2–order5	string	Sort field names (up to 5).
orderdesc / orderdesc2–orderdesc5	boolean	Sort direction for each order field.
page_no	integer	Page number for pagination.
page_size	integer	Page size for pagination.
pageinate	boolean	Enable pagination.
search	string	Filter by search string.
user_id	integer	Filter by user ID.

Response: 200 OK

---

POST /AssetChange — Create Device Change(s)

Creates one or more DeviceChange records.

Request Body — Array of DeviceChange objects (JSON).

Response: 200 OK

---

DeviceLicence

GET /DeviceLicence — List Device Licences

Returns device licence records.

Response: 200 OK

---

DeviceMeterReading

GET /MeterReading — List Meter Readings

Returns multiple DeviceMeterReading records. Requires authentication.

Query Parameters

Name	Type	Description
asset_id	integer	Filter by asset ID.
count	integer	Number of records to return.
page_no	integer	Page number for pagination.
page_size	integer	Page size for pagination.
pageinate	boolean	Enable pagination.
recurringinvoice_line_id	integer	Filter by recurring invoice line ID.

Response: 200 OK

---

POST /MeterReading — Create Meter Reading(s)

Creates one or more DeviceMeterReading records.

Request Body — Array of DeviceMeterReading objects (JSON).

Response: 200 OK

---

GET /MeterReading/{id} — Get One Meter Reading

Returns a single DeviceMeterReading by ID. Requires authentication.

Path Parameters

Name	Type	Required	Description
id	integer	Yes	Meter reading ID.

Query Parameters

Name	Type	Description
includedetails	boolean	Include extra details in the response.

Response: 200 OK

---

Certificate

GET /Certificate — List Certificates

Returns certificate records.

Response: 200 OK

---

POST /Certificate — Create Certificate(s)

Creates one or more Certificate records.

Request Body — Array of Certificate objects (JSON).

Response: 200 OK

---

GET /Certificate/{id} — Get One Certificate

Returns a single Certificate by ID. Requires authentication.

Path Parameters

Name	Type	Required	Description
id	integer	Yes	Certificate ID.

Query Parameters

Name	Type	Description
includedetails	boolean	Include extra details in the response.

Response: 200 OK

---

DELETE /Certificate/{id} — Delete Certificate

Deletes the certificate with the given ID.

Path Parameters

Name	Type	Required	Description
id	integer	Yes	Certificate ID.

Response: 200 OK

---

Licence

GET /SoftwareLicence — List Software Licences

Returns multiple Licence records. Requires authentication.

Query Parameters

Name	Type	Description
client_id	integer	Filter by client ID.
count	integer	Number of records to return.
includeinactive	boolean	Include inactive licences.
licence_type	integer	Filter by licence type.
order / order2–order5	string	Sort field names (up to 5).
orderdesc / orderdesc2–orderdesc5	boolean	Sort direction for each order field.
page_no	integer	Page number for pagination.
page_size	integer	Page size for pagination.
pageinate	boolean	Enable pagination.
search	string	Filter by search string.
site_id	integer	Filter by site ID.
tenant_id	string	Filter by tenant ID.
toplevelid	integer	Filter by top-level licence ID.

Response: 200 OK

---

POST /SoftwareLicence — Create Software Licence(s)

Creates one or more Licence records.

Request Body — Array of Licence_List objects (JSON).

Response: 200 OK

---

GET /SoftwareLicence/{id} — Get One Software Licence

Returns a single Licence by ID. Requires authentication.

Path Parameters

Name	Type	Required	Description
id	integer	Yes	Licence ID.

Query Parameters

Name	Type	Description
includedetails	boolean	Include extra details in the response.

Response: 200 OK

---

DELETE /SoftwareLicence/{id} — Delete Software Licence

Deletes the licence with the given ID.

Path Parameters

Name	Type	Required	Description
id	integer	Yes	Licence ID.

Response: 200 OK

---

LicenceChange

GET /LicenceChange — List Licence Changes

Returns multiple LicenceChange records. Requires authentication.

Query Parameters

Name	Type	Description
change_date	string	Filter by change date.
count	integer	Number of records to return.
idonly	boolean	Return only IDs.
licence_id	integer	Filter by licence ID.
order / order2–order5	string	Sort field names (up to 5).
orderdesc / orderdesc2–orderdesc5	boolean	Sort direction for each order field.
page_no	integer	Page number for pagination.
page_size	integer	Page size for pagination.
pageinate	boolean	Enable pagination.
search	string	Filter by search string.

Response: 200 OK

---

LicenceInfo

GET /LicenseInfo — List Licence Info

Returns multiple LicenceInfo records. Requires authentication.

Query Parameters

Name	Type	Description
advanced_search	string	Advanced search string.
count	integer	Number of records to return.
order / order2–order5	string	Sort field names (up to 5).
orderdesc / orderdesc2–orderdesc5	boolean	Sort direction for each order field.
page_no	integer	Page number for pagination.
page_size	integer	Page size for pagination.
pageinate	boolean	Enable pagination.
site_id	integer	Filter by site ID.

Response: 200 OK

---

POST /LicenseInfo — Create Licence Info

Creates one or more LicenceInfo records.

Request Body — Array of LicenceInfo objects (JSON).

Response: 200 OK

---

GET /LicenseInfo/password — Get Licence Password

Returns the password for a licence info record.

Response: 200 OK

---

LicenceRole

GET /SoftwareLicenceRole — List Licence Roles

Returns multiple LicenceRole records. Requires authentication.

Query Parameters

Name	Type	Description
softwarelicence_id	integer	Filter by software licence ID.

Response: 200 OK

---