ContactsLog inGet startedAsk Navixy AI

Inventory

Inventories are collections of devices used to organize and manage equipment more efficiently. They serve as logical groupings that help structure, track, and operate devices.

Inventory object

Inventory endpoints

List inventories

get
/v0/inventory/list

Returns all inventories available to the organization

Authorizations
OAuth2authorizationCodeRequired

OAuth 2.0 authentication for Europe. Use this for users based in Europe and adjacent regions.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : OpenID Connect scope
  • : Basic user profile
  • : User e-mail address
Query parameters
qstringOptional

A search query string

limitinteger · int32 · max: 1000Optional

Maximum number of items to return (default: 100, max: 1000)

offsetinteger · int32Optional

The index of the first item to return (default: 0)

sortstringOptional

Sort expression. Supports one or more fields, optionally prefixed with - to indicate descending order. For example, label,-created_at

Responses
200

List of inventories

application/json
get
/v0/inventory/list
GET /repo/v0/inventory/list HTTP/1.1
Host: api.navixy.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [],
  "has_more": true
}

List inventories with advanced filtering

post
/v0/inventory/list

Returns all inventories available to the organization with advanced filtering options

Authorizations
OAuth2authorizationCodeRequired

OAuth 2.0 authentication for Europe. Use this for users based in Europe and adjacent regions.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : OpenID Connect scope
  • : Basic user profile
  • : User e-mail address
Body
qstringOptional

A search query string

limitinteger · int32 · max: 1000Optional

Maximum number of items to return

Default: 100
offsetinteger · int32Optional

The index of the first item to return

Default: 0
sortstringOptional

Sort expression. Supports one or more fields, optionally prefixed with - to indicate descending order. For example, label,-created_at

Responses
200

List of inventories

application/json
post
/v0/inventory/list
POST /repo/v0/inventory/list HTTP/1.1
Host: api.navixy.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "q": "text",
  "conditions": {
    "type": "gte",
    "field": "created_at",
    "value": "2025-07-12T17:00:00Z"
  },
  "limit": 100,
  "offset": 0,
  "sort": "text"
}
{
  "data": [],
  "has_more": true
}

Create a new inventory

post
/v0/inventory/create

Adds a new inventory for the organization

Authorizations
OAuth2authorizationCodeRequired

OAuth 2.0 authentication for Europe. Use this for users based in Europe and adjacent regions.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : OpenID Connect scope
  • : Basic user profile
  • : User e-mail address
Body
labelstringRequired

The inventory's label

Example: Dutch
descriptionstringRequired

The detailed inventory description

Example: Dutch branch office
Responses
200

Inventory created successfully

application/json
post
/v0/inventory/create
POST /repo/v0/inventory/create HTTP/1.1
Host: api.navixy.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "label": "Dutch",
  "description": "Dutch branch office"
}
{
  "id": 123
}

Get inventory by ID

get
/v0/inventory/read

Returns an inventory's data by ID

Authorizations
OAuth2authorizationCodeRequired

OAuth 2.0 authentication for Europe. Use this for users based in Europe and adjacent regions.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : OpenID Connect scope
  • : Basic user profile
  • : User e-mail address
Query parameters
idinteger · int64Required

Unique identifier for the inventory

Responses
200

Inventory details

application/json
get
/v0/inventory/read
GET /repo/v0/inventory/read?id=1 HTTP/1.1
Host: api.navixy.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": 12,
  "label": "Dutch",
  "description": "Dutch branch office",
  "created_at": "2025-06-30T06:46:10Z"
}

Update an existing inventory

post
/v0/inventory/update

Updates the information of an existing inventory

Authorizations
OAuth2authorizationCodeRequired

OAuth 2.0 authentication for Europe. Use this for users based in Europe and adjacent regions.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : OpenID Connect scope
  • : Basic user profile
  • : User e-mail address
Body
idinteger · int64Required

Unique identifier for the inventory

Example: 12
labelstringRequired

The inventory's label

Example: Dutch
descriptionstringRequired

The detailed inventory description

Example: Dutch branch office
Responses
post
/v0/inventory/update
POST /repo/v0/inventory/update HTTP/1.1
Host: api.navixy.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "id": 12,
  "label": "Dutch",
  "description": "Dutch branch office"
}
No content

Delete an inventory

post
/v0/inventory/delete

Deletes the specified inventory by its ID

Authorizations
OAuth2authorizationCodeRequired

OAuth 2.0 authentication for Europe. Use this for users based in Europe and adjacent regions.

Authorization URL: Token URL: Refresh URL:
Available scopes:
  • : OpenID Connect scope
  • : Basic user profile
  • : User e-mail address
Body
idinteger · int64Required

Unique identifier of the resource to delete

Example: 42
forcebooleanRequired

If true, forces deletion even if the resource has related objects or dependencies

Responses
post
/v0/inventory/delete
POST /repo/v0/inventory/delete HTTP/1.1
Host: api.navixy.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "id": 42,
  "force": true
}
No content
PreviousAPI referenceNextInventory item

Last updated

Was this helpful?