Queries

circle-exclamation

deviceTypes

Lists device types for an organization.

deviceTypes(
    organizationId: ID!
    filter: CatalogItemFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
  ): DeviceTypeConnection!

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve device types for.

filter

CatalogItemFilter

Filtering options for the returned device types.

first

Int

The first n elements from the paginated listarrow-up-right.

after

String

The elements that come after the specified cursorarrow-up-right.

last

Int

The last n elements from the paginated listarrow-up-right.

before

String

The elements that come before the specified cursorarrow-up-right.

orderBy

CatalogItemOrder

The ordering options for the returned device types.

Input types:

chevron-rightCatalogItemFilterhashtag

Filtering options for catalog items.

Field
Type
Description

titleContains

String

Partial match on title (case-insensitive contains).

codes

[Code!]

Match any of these codes.

chevron-rightCatalogItemOrderhashtag

Ordering options for catalog items.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

chevron-rightDeviceTypeConnectionhashtag

A paginated list of DeviceType items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.

chevron-rightPageInfo (entity)hashtag

Information about the current page in a paginated connection.

Field
Type
Description

hasNextPage

Boolean!

Whether more items exist after the current page.

hasPreviousPage

Boolean!

Whether more items exist before the current page.

startCursor

String

The cursor pointing to the first item in the current page.

endCursor

String

The cursor pointing to the last item in the current page.


deviceStatuses

Lists device statuses for an organization.

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve device statuses for.

filter

CatalogItemFilter

Filtering options for the returned device statuses.

first

Int

The first n elements from the paginated listarrow-up-right.

after

String

The elements that come after the specified cursorarrow-up-right.

last

Int

The last n elements from the paginated listarrow-up-right.

before

String

The elements that come before the specified cursorarrow-up-right.

orderBy

CatalogItemOrder

The ordering options for the returned device statuses.

Input types:

chevron-rightCatalogItemFilterhashtag

Filtering options for catalog items.

Field
Type
Description

titleContains

String

Partial match on title (case-insensitive contains).

codes

[Code!]

Match any of these codes.

chevron-rightCatalogItemOrderhashtag

Ordering options for catalog items.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

chevron-rightDeviceStatusConnectionhashtag

A paginated list of DeviceStatus items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.

chevron-rightPageInfo (entity)hashtag

Information about the current page in a paginated connection.

Field
Type
Description

hasNextPage

Boolean!

Whether more items exist after the current page.

hasPreviousPage

Boolean!

Whether more items exist before the current page.

startCursor

String

The cursor pointing to the first item in the current page.

endCursor

String

The cursor pointing to the last item in the current page.


deviceModels

Lists device models with optional vendor filter.

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve device models for.

filter

DeviceModelFilter

Filtering options for the returned device models.

first

Int

The first n elements from the paginated listarrow-up-right.

after

String

The elements that come after the specified cursorarrow-up-right.

last

Int

The last n elements from the paginated listarrow-up-right.

before

String

The elements that come before the specified cursorarrow-up-right.

orderBy

CatalogItemOrder

The ordering options for the returned device models.

Input types:

chevron-rightDeviceModelFilterhashtag

Filtering options for device models.

Field
Type
Description

vendorIds

[ID!]

Filter by vendors (OR within field).

titleContains

String

Partial match on title (case-insensitive contains).

code

Code

Exact code match.

chevron-rightCatalogItemOrderhashtag

Ordering options for catalog items.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

chevron-rightDeviceModelConnectionhashtag

A paginated list of DeviceModel items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.

chevron-rightPageInfo (entity)hashtag

Information about the current page in a paginated connection.

Field
Type
Description

hasNextPage

Boolean!

Whether more items exist after the current page.

hasPreviousPage

Boolean!

Whether more items exist before the current page.

startCursor

String

The cursor pointing to the first item in the current page.

endCursor

String

The cursor pointing to the last item in the current page.


device

Retrieves a device by its ID.

Arguments

Name
Type
Description

id

ID!

The ID of the device to retrieve.

Output types:

chevron-rightDevicehashtag

A tracking device such as a GPS tracker, sensor, or beacon.

Implements: Node, Titled, Versioned, InventoryItem

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

title

String!

The human-readable display name.

organization

The organization that owns this device.

type

The device type classification.

model

The specific device model.

status

The current operational status.

identifiers

The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).

inventory

The inventory this device is currently assigned to.

relationsFrom

The outgoing relationships from this device to other devices.

relationsTo

The incoming relationships from other devices to this device.

inventoryHistory

The history of inventory assignments for this device.

chevron-rightOrganization (entity)hashtag

An organization in the hierarchy that owns entities and users.

Implements: Node, Versioned, Titled

Field
Type
Description

id

ID!

A globally unique identifier. This ID is opaque and should not be parsed by clients.

version

Int!

The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.

title

String!

The human-readable display name.

externalId

String

An external system identifier for integration purposes.

isActive

Boolean!

Whether this organization is active.

features

The feature flags enabled for this organization.

parent

The parent organization in the hierarchy. Null for root organizations.

children

The child organizations.

members

The members of this organization.

devices

The devices owned by this organization.

assets

The assets owned by this organization.

geoObjects

The geographic objects owned by this organization.

schedules

The schedules owned by this organization.


devices

Lists devices for an organization.

Arguments

Name
Type
Description

organizationId

ID!

The organization to retrieve devices for.

filter

DeviceFilter

Filtering options for the returned devices.

first

Int

The first n elements from the paginated listarrow-up-right.

after

String

The elements that come after the specified cursorarrow-up-right.

last

Int

The last n elements from the paginated listarrow-up-right.

before

String

The elements that come before the specified cursorarrow-up-right.

orderBy

DeviceOrder

The ordering options for the returned devices.

Input types:

chevron-rightDeviceFilterhashtag

Filtering options for devices.

Field
Type
Description

typeIds

[ID!]

Filter by device types (OR within field).

modelIds

[ID!]

Filter by device models (OR within field).

statusIds

[ID!]

Filter by statuses (OR within field).

vendorIds

[ID!]

Filter by vendors (OR within field).

identifierContains

String

Partial match on device identifier value (case-sensitive contains).

inventoryIds

[ID!]

Filter by inventories (OR within field).

titleContains

String

Partial match on title (case-insensitive contains).

chevron-rightDeviceOrderhashtag

Ordering options for devices.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

chevron-rightDeviceConnectionhashtag

A paginated list of Device items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

[Device!]!

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.

chevron-rightPageInfo (entity)hashtag

Information about the current page in a paginated connection.

Field
Type
Description

hasNextPage

Boolean!

Whether more items exist after the current page.

hasPreviousPage

Boolean!

Whether more items exist before the current page.

startCursor

String

The cursor pointing to the first item in the current page.

endCursor

String

The cursor pointing to the last item in the current page.


Last updated

Was this helpful?