API reference

Navixy Repository API is a powerful asset management system that enables you to create fully customized trackable assets with any properties you need, assign GPS devices to make them location-aware, and establish relationships between assets to model your exact business operations.

Overview

This document is a reference sheet for Navixy Repository API. It briefly outlines authentication, server URLs, and endpoint names, methods, and parameters. For a detailed description of endpoints, grouped by resource, see their dedicated pages nested inside this article.

Authentication

All API requests require OAuth 2.0 Bearer authentication. Include your access token in the Authorization header:

Authorization: Bearer <ACCESS_TOKEN>

For a detailed authentication flow, see Authentication.

URLs

Region	Base URL	Auth URL
Europe	https://api.navixy.com/repo/v0	https://keycloak.navixy.com
Americas	https://api.us.navixy.com/repo/v0	https://keycloak.us.navixy.com

API specification

Nested inside this page is a complete and interactive API reference generated from an up-to-date OpenAPI specification. It contains full endpoint paths, parameters, object schemas (models), and test API calls right from the documentation. You can view the original OpenAPI specification used to generate our API docs here.

Endpoints

Inventory

Endpoint	Method	Description	Key Parameters
inventory/list	GET	List inventories with basic filtering	q, limit, offset, sort
inventory/list	POST	List inventories with advanced filtering	q, conditions, limit, offset, sort
inventory/create	POST	Create a new inventory	label, description
inventory/read	GET	Get inventory by ID	id
inventory/update	POST	Update an existing inventory	id, label, description
inventory/delete	POST	Delete an inventory	id, force

Inventory item

Master

Endpoint	Method	Description	Key Parameters
inventory_item/master/list	GET	List master items with basic filtering	q, limit, offset, sort
inventory_item/master/list	POST	List master items with advanced filtering	q, conditions, limit, offset, sort
inventory_item/master/create	POST	Create a new master item	label, inventory_id, model, device_id, asset_id
inventory_item/master/read	GET	Get master item by ID	id
inventory_item/master/update	POST	Update an existing master item	id, label, inventory_id, model, device_id, asset_id
inventory_item/master/activate	POST	Activate a master item	id, model, device_id, activation_method_id, fields
inventory_item/master/archive	POST	Archive a master item	id
inventory_item/master/model/list	GET	List master item models	q, limit, offset, sort

Slave

Endpoint	Method	Description	Key Parameters
inventory_item/slave/list	GET	List slave items with basic filtering	q, limit, offset, sort
inventory_item/slave/list	POST	List slave items with advanced filtering	q, conditions, limit, offset, sort
inventory_item/slave/create	POST	Create a new slave item	label, inventory_id, asset_id, master_id
inventory_item/slave/read	GET	Get slave item by ID	id
inventory_item/slave/update	POST	Update an existing slave item	id, label, inventory_id, asset_id, master_id
inventory_item/slave/delete	POST	Delete a slave item	id
inventory_item/slave/pair	POST	Pair a slave with a master item	id, master_id

Asset

Endpoint	Method	Description	Key Parameters
asset/list	GET	List assets with basic filtering	q, limit, offset, sort
asset/list	POST	List assets with advanced filtering	q, conditions, limit, offset, sort
asset/create	POST	Create a new asset	type_id, label, fields
asset/read	GET	Get asset by ID	id
asset/update	POST	Update an existing asset	id, label, fields
asset/delete	POST	Delete an asset	id

Asset type

Endpoint	Method	Description	Key Parameters
asset_type/list	GET	List asset types with basic filtering	q, limit, offset, sort
asset_type/list	POST	List asset types with advanced filtering	q, conditions, limit, offset, sort
asset_type/create	POST	Create a new asset type	label, category, fields, settings
asset_type/read	GET	Get asset type by ID	id
asset_type/update	POST	Update an asset type	id, label, category, fields, settings
asset_type/delete	POST	Delete an asset type	id, force

Asset link

Endpoint	Method	Description	Key Parameters
asset_link/list	GET	List asset links with basic filtering	q, limit, offset, sort
asset_link/list	POST	List asset links with advanced filtering	q, conditions, limit, offset, sort
asset_link/create	POST	Create a new asset link	label, asset_ids
asset_link/read	GET	Get asset link by ID	id
asset_link/update	POST	Update an existing asset link	id, label, asset_ids
asset_link/delete	POST	Delete an asset link	id
asset_link/set	POST	Assign asset to a link	link_id, asset_id
asset_link/remove	POST	Unassign asset from a link	link_id, asset_id