Objects

Objects are the return types for queries and mutations. They represent the data structures in the Navixy API.

Devices

Device

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

Implements: Node, Titled, Customizable, Versioned, InventoryItem

Field	Type	Description
id	ID!
version	Int!
title	String!
organization	Organization!	The organization that owns this device.
type	DeviceType!	The device type classification.
model	DeviceModel!	The specific device model.
status	DeviceStatus!	The current operational status.
customFields	JSON!
identifiers	[DeviceIdentifier!]!	The hardware identifiers for this device (IMEI, serial number, MAC address, etc.).
inventory	Inventory	The inventory this device is currently assigned to.
relationsFrom	[DeviceRelation!]!	The outgoing relationships from this device to other devices.
relationsTo	[DeviceRelation!]!	The incoming relationships from other devices to this device.
inventoryHistory	DeviceInventoryRelationConnection!	The history of inventory assignments for this device.

DeviceIdentifier

A hardware identifier for a device.

Implements: Node

Field	Type	Description
id	ID!
device	Device!	The device this identifier belongs to.
type	DeviceIdType!	The type of identifier.
value	String!	The identifier value.
namespace	Code	The namespace for uniqueness scope. Null means the identifier is globally unique.

DeviceRelation

A relationship between two devices.

Implements: Node

Field	Type	Description
id	ID!
first	Device!	The first device in the relationship.
second	Device!	The second device in the relationship.
type	DeviceRelationType!	The type of relationship.

DeviceInventoryRelation

A record of a device's assignment to an inventory.

Implements: Node

Field	Type	Description
id	ID!
device	Device!	The device that was assigned.
inventory	Inventory!	The inventory the device was assigned to.
assignedAt	DateTime!	The date and time when the device was assigned.
assignedBy	Actor	The actor who assigned the device.

Assets

AssetGroupTypeConstraint

A constraint defining which asset types can be included in an asset group type.

Field	Type	Description
assetType	AssetType!	The asset type allowed in the group.
maxItems	Int	The maximum number of assets of this type allowed in one group. Null means unlimited.

Asset

A physical or logical asset being tracked.

Implements: Node, Titled, Customizable, Versioned

Field	Type	Description
id	ID!
version	Int!
title	String!
organization	Organization!	The organization that owns this asset.
type	AssetType!	The asset type classification.
customFields	JSON!
device	Device	The primary tracking device linked to this asset. This is an alias for the device custom field.
groups	AssetGroupConnection!	The groups this asset belongs to.

AssetGroup

A group of assets.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
organization	Organization!	The organization that owns this group.
type	AssetGroupType!	The group type with membership constraints.
color	HexColorCode	The color for UI display in hexadecimal format.
currentAssets	AssetConnection!	The assets currently in this group.
history	AssetGroupItemConnection!	The full membership history for this group.

AssetGroupItem

A record of an asset's membership in a group.

Implements: Node

Field	Type	Description
id	ID!
group	AssetGroup!	The group containing the asset.
asset	Asset!	The asset in the group.
attachedAt	DateTime!	The date and time when the asset was added to the group.
detachedAt	DateTime	The date and time when the asset was removed from the group. Null means the asset is currently attached.

Geo objects

GeoObject

A geographic object such as a geofence, point of interest, or route.

Implements: Node, Titled, Customizable, Versioned

Field	Type	Description
id	ID!
version	Int!
title	String!
organization	Organization!	The organization that owns this geo object.
type	GeoObjectType!	The geo object type classification.
geometry	GeoJSON!	The geographic shape of this object as GeoJSON geometry. This is an alias for the geojson custom field.
customFields	JSON!
containsPoints	[PointContainmentResult!]!	Checks if the given points are contained within this geo object's geometry. Returns the containment status for each point. Only applicable to Polygon and MultiPolygon geometries.

Schedules

Schedule

A schedule definition for work hours, maintenance windows, or other time-based rules.

Implements: Node, Titled, Customizable, Versioned

Field	Type	Description
id	ID!
version	Int!
title	String!
organization	Organization!	The organization that owns this schedule.
type	ScheduleType!	The schedule type classification.
scheduleData	ScheduleData!	The calendar and time interval definitions for this schedule. This is an alias for the schedule_data custom field.
customFields	JSON!

Inventory

Inventory

An inventory or warehouse record for device stock management.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
organization	Organization!	The organization that owns this inventory.
devices	DeviceConnection!	The devices assigned to this inventory.

Organizations

Organization

An organization in the hierarchy that owns entities and users.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
externalId	String	An external system identifier for integration purposes.
isActive	Boolean!	Whether this organization is active.
features	[OrganizationFeature!]!	The feature flags enabled for this organization.
parent	Organization	The parent organization in the hierarchy. Null for root organizations.
children	OrganizationConnection!	The child organizations.
members	MemberConnection!	The members of this organization.
devices	DeviceConnection!	The devices owned by this organization.
assets	AssetConnection!	The assets owned by this organization.
geoObjects	GeoObjectConnection!	The geographic objects owned by this organization.
schedules	ScheduleConnection!	The schedules owned by this organization.

Actors

PersonName

Structured person name components following W3C Personal Names guidance. See: https://www.w3.org/International/questions/qa-personal-names Examples by culture: - US: givenNames="John", familyNames="Smith", middleName="Robert" - Russia: givenNames="Иван", familyNames="Иванов", middleName="Петрович" (patronymic) - Spain: givenNames="Juan Carlos", familyNames="García López" (paternal + maternal) - China: givenNames="明" (Ming), familyNames="王" (Wang) — note: family name first in native order - Iceland: givenNames="Björk", familyNames="Guðmundsdóttir" (patronymic as family name)

Field	Type	Description
givenNames	String!	The given name(s), also known as first name(s). May contain multiple names separated by spaces.
familyNames	String!	The family name(s), also known as surname(s) or last name(s). May contain multiple names.
middleName	String	The middle name, patronymic, or additional name component.
fullName	String!	The full name formatted according to the user's locale preferences.

User

A human user account authenticated via an identity provider.

Implements: Actor, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!	The display name for the user. This is the user's full name for display purposes.
name	PersonName!	The structured name components from the identity provider.
identityProvider	String!	The identity provider name (keycloak, auth0, okta, etc.).
identityProviderId	String!	The user's unique ID in the identity provider.
email	EmailAddress!	The user's primary email address.
locale	Locale	The user's preferred locale.
externalId	String	An external system identifier for integration purposes.
isActive	Boolean!	Whether this user account is active.
memberships	MemberConnection!	The organization memberships for this user.

Member

A user's membership in an organization.

Implements: Node, Customizable, Versioned

Field	Type	Description
id	ID!
version	Int!
user	User!	The user.
organization	Organization!	The organization the user belongs to.
isActive	Boolean!	Whether this membership is active.
assignedAt	DateTime!	The date and time when the user was assigned to this organization.
customFields	JSON!	Membership-specific custom fields such as position and department.

Integration

An external system integration with API access.

Implements: Actor, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
organization	Organization!	The organization this integration belongs to.
credentialRef	String	A reference to credentials stored in a secure vault.
isActive	Boolean!	Whether this integration is active.

Access control

ActorRole

An assignment of a role to an actor.

Implements: Node

Field	Type	Description
id	ID!
actor	Actor!	The actor receiving the role.
role	Role!	The role being assigned.
assignedAt	DateTime!	The date and time when the role was assigned.
assignedBy	Actor	The actor who assigned the role.
expireDate	DateTime	The date and time when the role expires. Null means the role is permanent.

RolePermission

A permission granted to a role.

Implements: Node

Field	Type	Description
id	ID!
role	Role!	The role receiving the permission.
permissionScope	PermissionScope!	The permission scope being granted.
targetEntityId	ID	The specific entity ID this permission applies to. Null means all entities of the type.
actions	[ActionPermission!]!	The actions allowed by this permission.
grantedAt	DateTime!	The date and time when the permission was granted.
grantedBy	Actor!	The actor who granted the permission.

UserScope

A whitelist filter that restricts an actor's access to specific entities. When present, effective permissions = role permissions ∩ user scope.

Implements: Node

Field	Type	Description
id	ID!
actor	Actor!	The actor being restricted.
permissionScope	PermissionScope!	The permission scope being filtered.
targetEntityId	ID!	The specific entity the actor can access.
actions	[ActionPermission!]!	The actions allowed on this specific entity.

Custom fields

CustomFieldDefinition

A custom field definition that specifies the metadata for a custom field. Note: The fieldType property is immutable after creation. To change the field type, delete the definition and create a new one.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!	The human-readable display name.
code	Code!	The machine-readable code, unique per owner and organization.
description	String	A description of the field for UI hints.
order	Int!	The display order within the owner context.
organization	Organization	The organization that owns this definition. Null for system-level fields.
owner	CatalogItem!	The owner catalog item: EntityType for system fields, or a specific type like AssetType for type-specific fields.
targetEntityType	EntityType!	The target entity type this field applies to.
fieldType	FieldType!	The data type determining validation rules and UI rendering. This property is immutable and cannot be changed after creation.
params	FieldParams!	The type-specific parameters for validation, defaults, and options.

FieldParamsString

Parameters for STRING field type.

Implements: FieldParams

Field	Type	Description
isRequired	Boolean!
minLength	Int	The minimum character length.
maxLength	Int	The maximum character length.
defaultValue	String	The default value.
trim	Boolean!	Whether to trim leading and trailing whitespace.

FieldParamsText

Parameters for TEXT field type.

Implements: FieldParams

Field	Type	Description
isRequired	Boolean!
maxLength	Int	The maximum character length.
defaultValue	String	The default value.
trim	Boolean!	Whether to trim leading and trailing whitespace.

FieldParamsNumber

Parameters for NUMBER field type.

Implements: FieldParams

Field	Type	Description
isRequired	Boolean!
min	Float	The minimum allowed value.
max	Float	The maximum allowed value.
precision	Int	The decimal precision.
defaultValue	Float	The default value.

FieldParamsBoolean

Parameters for BOOLEAN field type.

Implements: FieldParams

Field	Type	Description
isRequired	Boolean!
defaultValue	Boolean	The default value.

FieldParamsDate

Parameters for DATE field type.

Implements: FieldParams

Field	Type	Description
isRequired	Boolean!
defaultValue	Date	The default value.

FieldParamsDatetime

Parameters for DATETIME field type.

Implements: FieldParams

Field	Type	Description
isRequired	Boolean!
defaultValue	DateTime	The default value.

FieldParamsGeojson

Parameters for GEOJSON field type.

Implements: FieldParams

Field	Type	Description
isRequired	Boolean!
allowedTypes	[GeoJsonGeometryType!]	The allowed geometry types. Null means all types are allowed.

FieldParamsSchedule

Parameters for SCHEDULE field type.

Implements: FieldParams

Field	Type	Description
isRequired	Boolean!

FieldParamsOptions

Parameters for OPTIONS field type.

Implements: FieldParams, MultiValue

Field	Type	Description
isRequired	Boolean!
isMulti	Boolean!
options	[FieldOption!]!	The available options to choose from.
defaultValue	Code	The default option code.

FieldOption

A single option in an OPTIONS field.

Field	Type	Description
code	Code!	The unique code for this option within the field.
label	String!	The display label.
description	String	A description of the option.
isArchived	Boolean!	Whether this option is archived and should not be shown for new selections.

FieldParamsDevice

Parameters for DEVICE field type.

Implements: FieldParams, MultiValue

Field	Type	Description
isRequired	Boolean!
isMulti	Boolean!

FieldParamsReference

Parameters for REFERENCE field type.

Implements: FieldParams, MultiValue

Field	Type	Description
isRequired	Boolean!
isMulti	Boolean!
refEntityTypeCode	Code!	The entity type code that can be referenced.

FieldParamsCatalog

Parameters for CATALOG field type.

Implements: FieldParams, MultiValue

Field	Type	Description
isRequired	Boolean!
isMulti	Boolean!
refCatalogCode	Code!	The catalog code that items can be selected from.
defaultValue	Code	The default item code.

FieldParamsTag

Parameters for TAG field type.

Implements: FieldParams, MultiValue

Field	Type	Description
isRequired	Boolean!
isMulti	Boolean!
defaultValue	Code	The default tag code.

Audit

AuditEvent

An audit log entry recording an event that occurred in the system.

Implements: Node

Field	Type	Description
id	ID!
organization	Organization	The organization context. Null for system events.
actor	Actor	The actor who triggered the event.
ipAddress	String	The client IP address.
userAgent	String	The client User-Agent string.
sourceType	SourceType!	The source type of the request.
traceId	String	The distributed tracing ID (32 hex characters) for log correlation.
aggregateType	Code	The type of entity affected.
aggregateId	ID	The ID of the affected entity.
eventType	AuditEventType!	The type of event that occurred.
eventData	JSON	The event payload with details such as changed fields.
occurredAt	DateTime!	The date and time when the event occurred.

Pagination

PageInfo

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.

CountInfo

Information about the total count of items in a connection.

Field	Type	Description
count	Int!	The count of items matching the filter.
precision	CountPrecision!	The precision level of the count value.

CatalogItemConnection

A paginated list of CatalogItem items.

Implements: Connection

Field	Type	Description
edges	[CatalogItemEdge!]!	A list of edges.
nodes	[CatalogItem!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

CatalogItemEdge

An edge in the CatalogItem connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	CatalogItem!	The catalog item at the end of the edge.

UserCatalogItemConnection

A paginated list of UserCatalogItem items.

Implements: Connection

Field	Type	Description
edges	[UserCatalogItemEdge!]!	A list of edges.
nodes	[UserCatalogItem!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

UserCatalogItemEdge

An edge in the UserCatalogItem connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	UserCatalogItem!	The user catalog item at the end of the edge.

OrganizationConnection

A paginated list of Organization items.

Implements: Connection

Field	Type	Description
edges	[OrganizationEdge!]!	A list of edges.
nodes	[Organization!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

OrganizationEdge

An edge in the Organization connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Organization!	The organization at the end of the edge.

UserConnection

A paginated list of User items.

Implements: Connection

Field	Type	Description
edges	[UserEdge!]!	A list of edges.
nodes	[User!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

UserEdge

An edge in the User connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	User!	The user at the end of the edge.

MemberConnection

A paginated list of Member items.

Implements: Connection

Field	Type	Description
edges	[MemberEdge!]!	A list of edges.
nodes	[Member!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

MemberEdge

An edge in the Member connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Member!	The member at the end of the edge.

IntegrationConnection

A paginated list of Integration items.

Implements: Connection

Field	Type	Description
edges	[IntegrationEdge!]!	A list of edges.
nodes	[Integration!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

IntegrationEdge

An edge in the Integration connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Integration!	The integration at the end of the edge.

DeviceConnection

A paginated list of Device items.

Implements: Connection

Field	Type	Description
edges	[DeviceEdge!]!	A list of edges.
nodes	[Device!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

DeviceEdge

An edge in the Device connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Device!	The device at the end of the edge.

AssetConnection

A paginated list of Asset items.

Implements: Connection

Field	Type	Description
edges	[AssetEdge!]!	A list of edges.
nodes	[Asset!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

AssetEdge

An edge in the Asset connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Asset!	The asset at the end of the edge.

AssetGroupConnection

A paginated list of AssetGroup items.

Implements: Connection

Field	Type	Description
edges	[AssetGroupEdge!]!	A list of edges.
nodes	[AssetGroup!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

AssetGroupEdge

An edge in the AssetGroup connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	AssetGroup!	The asset group at the end of the edge.

AssetGroupItemConnection

A paginated list of AssetGroupItem items.

Implements: Connection

Field	Type	Description
edges	[AssetGroupItemEdge!]!	A list of edges.
nodes	[AssetGroupItem!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

AssetGroupItemEdge

An edge in the AssetGroupItem connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	AssetGroupItem!	The asset group item at the end of the edge.

InventoryConnection

A paginated list of Inventory items.

Implements: Connection

Field	Type	Description
edges	[InventoryEdge!]!	A list of edges.
nodes	[Inventory!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

InventoryEdge

An edge in the Inventory connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Inventory!	The inventory at the end of the edge.

GeoObjectConnection

A paginated list of GeoObject items.

Implements: Connection

Field	Type	Description
edges	[GeoObjectEdge!]!	A list of edges.
nodes	[GeoObject!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

GeoObjectEdge

An edge in the GeoObject connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	GeoObject!	The geo object at the end of the edge.

ScheduleConnection

A paginated list of Schedule items.

Implements: Connection

Field	Type	Description
edges	[ScheduleEdge!]!	A list of edges.
nodes	[Schedule!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

ScheduleEdge

An edge in the Schedule connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Schedule!	The schedule at the end of the edge.

AuditEventConnection

A paginated list of AuditEvent items.

Implements: Connection

Field	Type	Description
edges	[AuditEventEdge!]!	A list of edges.
nodes	[AuditEvent!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

AuditEventEdge

An edge in the AuditEvent connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	AuditEvent!	The audit event at the end of the edge.

DeviceInventoryRelationConnection

A paginated list of DeviceInventoryRelation items.

Implements: Connection

Field	Type	Description
edges	[DeviceInventoryRelationEdge!]!	A list of edges.
nodes	[DeviceInventoryRelation!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

DeviceInventoryRelationEdge

An edge in the DeviceInventoryRelation connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	DeviceInventoryRelation!	The device inventory relation at the end of the edge.

CatalogConnection

A paginated list of Catalog items.

Implements: Connection

Field	Type	Description
edges	[CatalogEdge!]!	A list of edges.
nodes	[Catalog!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

CatalogEdge

An edge in the Catalog connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Catalog!	The catalog at the end of the edge.

DeviceTypeConnection

A paginated list of DeviceType items.

Implements: Connection

Field	Type	Description
edges	[DeviceTypeEdge!]!	A list of edges.
nodes	[DeviceType!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

DeviceTypeEdge

An edge in the DeviceType connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	DeviceType!	The device type at the end of the edge.

DeviceStatusConnection

A paginated list of DeviceStatus items.

Implements: Connection

Field	Type	Description
edges	[DeviceStatusEdge!]!	A list of edges.
nodes	[DeviceStatus!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

DeviceStatusEdge

An edge in the DeviceStatus connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	DeviceStatus!	The device status at the end of the edge.

DeviceModelConnection

A paginated list of DeviceModel items.

Implements: Connection

Field	Type	Description
edges	[DeviceModelEdge!]!	A list of edges.
nodes	[DeviceModel!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

DeviceModelEdge

An edge in the DeviceModel connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	DeviceModel!	The device model at the end of the edge.

AssetTypeConnection

A paginated list of AssetType items.

Implements: Connection

Field	Type	Description
edges	[AssetTypeEdge!]!	A list of edges.
nodes	[AssetType!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

AssetTypeEdge

An edge in the AssetType connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	AssetType!	The asset type at the end of the edge.

AssetGroupTypeConnection

A paginated list of AssetGroupType items.

Implements: Connection

Field	Type	Description
edges	[AssetGroupTypeEdge!]!	A list of edges.
nodes	[AssetGroupType!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

AssetGroupTypeEdge

An edge in the AssetGroupType connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	AssetGroupType!	The asset group type at the end of the edge.

GeoObjectTypeConnection

A paginated list of GeoObjectType items.

Implements: Connection

Field	Type	Description
edges	[GeoObjectTypeEdge!]!	A list of edges.
nodes	[GeoObjectType!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

GeoObjectTypeEdge

An edge in the GeoObjectType connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	GeoObjectType!	The geo object type at the end of the edge.

ScheduleTypeConnection

A paginated list of ScheduleType items.

Implements: Connection

Field	Type	Description
edges	[ScheduleTypeEdge!]!	A list of edges.
nodes	[ScheduleType!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

ScheduleTypeEdge

An edge in the ScheduleType connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	ScheduleType!	The schedule type at the end of the edge.

RoleConnection

A paginated list of Role items.

Implements: Connection

Field	Type	Description
edges	[RoleEdge!]!	A list of edges.
nodes	[Role!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

RoleEdge

An edge in the Role connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Role!	The role at the end of the edge.

TagConnection

A paginated list of Tag items.

Implements: Connection

Field	Type	Description
edges	[TagEdge!]!	A list of edges.
nodes	[Tag!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

TagEdge

An edge in the Tag connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Tag!	The tag at the end of the edge.

ActorRoleConnection

A paginated list of ActorRole items.

Implements: Connection

Field	Type	Description
edges	[ActorRoleEdge!]!	A list of edges.
nodes	[ActorRole!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

ActorRoleEdge

An edge in the ActorRole connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	ActorRole!	The actor role at the end of the edge.

RolePermissionConnection

A paginated list of RolePermission items.

Implements: Connection

Field	Type	Description
edges	[RolePermissionEdge!]!	A list of edges.
nodes	[RolePermission!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

RolePermissionEdge

An edge in the RolePermission connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	RolePermission!	The role permission at the end of the edge.

UserScopeConnection

A paginated list of UserScope items.

Implements: Connection

Field	Type	Description
edges	[UserScopeEdge!]!	A list of edges.
nodes	[UserScope!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

UserScopeEdge

An edge in the UserScope connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	UserScope!	The user scope at the end of the edge.

Mutation payloads

DeletePayload

The result of a delete mutation.

Field	Type	Description
deletedId	ID!	The ID of the deleted entity.

DevicePayload

The result of a device mutation.

Field	Type	Description
device	Device!	The created or updated device.

AssetPayload

The result of an asset mutation.

Field	Type	Description
asset	Asset!	The created or updated asset.

AssetGroupPayload

The result of an asset group mutation.

Field	Type	Description
assetGroup	AssetGroup!	The created or updated asset group.

GeoObjectPayload

The result of a geo object mutation.

Field	Type	Description
geoObject	GeoObject!	The created or updated geo object.

SchedulePayload

The result of a schedule mutation.

Field	Type	Description
schedule	Schedule!	The created or updated schedule.

InventoryPayload

The result of an inventory mutation.

Field	Type	Description
inventory	Inventory!	The created or updated inventory.

OrganizationPayload

The result of an organization mutation.

Field	Type	Description
organization	Organization!	The created or updated organization.

UserPayload

The result of a user profile mutation.

Field	Type	Description
user	User!	The updated user.

MemberPayload

The result of a membership mutation.

Field	Type	Description
member	Member!	The created or updated membership.

IntegrationPayload

The result of an integration mutation.

Field	Type	Description
integration	Integration!	The created or updated integration.

CustomFieldDefinitionPayload

The result of a custom field definition mutation.

Field	Type	Description
customFieldDefinition	CustomFieldDefinition!	The created or updated custom field definition.

DeviceIdentifierPayload

The result of a device identifier mutation.

Field	Type	Description
deviceIdentifier	DeviceIdentifier!	The added device identifier.

AssetGroupItemPayload

The result of an asset group item mutation.

Field	Type	Description
assetGroupItem	AssetGroupItem!	The created group membership record.

DeviceInventoryRelationPayload

The result of a device inventory link mutation.

Field	Type	Description
deviceInventoryRelation	DeviceInventoryRelation!	The created inventory assignment.

DeviceRelationPayload

The result of a device relation mutation.

Field	Type	Description
deviceRelation	DeviceRelation!	The created device relationship.

ActorRolePayload

The result of a role assignment mutation.

Field	Type	Description
actorRole	ActorRole!	The created role assignment.

RolePermissionPayload

The result of a permission grant mutation.

Field	Type	Description
rolePermission	RolePermission!	The created permission.

UserScopePayload

The result of a user scope mutation.

Field	Type	Description
userScope	UserScope!	The created user scope restriction.

DeviceTypePayload

The result of a device type mutation.

Field	Type	Description
deviceType	DeviceType!	The created or updated device type.

DeviceStatusPayload

The result of a device status mutation.

Field	Type	Description
deviceStatus	DeviceStatus!	The created or updated device status.

AssetTypePayload

The result of an asset type mutation.

Field	Type	Description
assetType	AssetType!	The created or updated asset type.

AssetGroupTypePayload

The result of an asset group type mutation.

Field	Type	Description
assetGroupType	AssetGroupType!	The created or updated asset group type.

GeoObjectTypePayload

The result of a geo object type mutation.

Field	Type	Description
geoObjectType	GeoObjectType!	The created or updated geo object type.

ScheduleTypePayload

The result of a schedule type mutation.

Field	Type	Description
scheduleType	ScheduleType!	The created or updated schedule type.

TagPayload

The result of a tag mutation.

Field	Type	Description
tag	Tag!	The created or updated tag.

RolePayload

The result of a role mutation.

Field	Type	Description
role	Role!	The created or updated role.

UserCatalogItemPayload

The result of a user catalog item mutation.

Field	Type	Description
item	UserCatalogItem!	The created or updated user catalog item.

Catalog items

CatalogItemMeta

Metadata about a catalog item.

Field	Type	Description
description	String	A description of the catalog item. Can be localized.
origin	CatalogItemOrigin!	The origin indicating how this item was created.
canBeDeleted	Boolean!	Whether this item can be deleted. Returns false if the item has dependencies or is system-managed.
hidden	Boolean!	Whether this item is hidden from regular UI lists.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon for this item.

Module

A system module that groups related functionality and permission scopes. Examples: repo (core), fleet_management (FSM), iot (devices), reports, billing.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!

EntityType

A definition of an entity type in the system.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
uuidDiscriminator	String!	The 4-character code embedded in UUIDs for entities of this type.
isCustomizable	Boolean!	Whether entities of this type support custom fields.
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions for entities of this type, ordered by display order.

DeviceVendor

A device manufacturer or vendor.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
models	DeviceModelConnection!	Device models produced by this vendor.

DeviceModel

A specific device model produced by a vendor.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
vendor	DeviceVendor!	The vendor that manufactures this model.

DeviceType

A classification type for devices.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions specific to this device type, ordered by display order.

DeviceStatus

An operational status for devices.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!

DeviceRelationType

A type of relationship between two devices.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!

AssetType

A classification type for assets.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions specific to this asset type, ordered by display order.

AssetGroupType

A type for asset groups with membership constraints.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
allowedAssetTypes	[AssetGroupTypeConstraint!]!	The asset types allowed in groups of this type, with optional quantity limits.

GeoObjectType

A classification type for geographic objects.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions specific to this geo object type, ordered by display order.

ScheduleType

A classification type for schedules.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
customFieldDefinitions	[CustomFieldDefinition!]!	Custom field definitions specific to this schedule type, ordered by display order.

Role

A role that can be assigned to actors to grant permissions.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
permissions	RolePermissionConnection!	The permissions assigned to this role.

PermissionScope

A definition of a permission scope that can be granted to roles.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
module	Module!	The module this permission scope belongs to.
entityType	EntityType!	The entity type this permission applies to.

Tag

A tag for labeling and categorizing entities.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
entityTypes	[EntityType!]!	The entity types this tag can be applied to. Empty means the tag is universal.

Country

A country reference data item.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
alpha2Code	CountryCode!	The ISO 3166-1 alpha-2 country code.

UserCatalogItem

A user-defined catalog item that supports hierarchical organization.

Implements: CatalogItem, HierarchicalCatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!
organization	Organization
meta	CatalogItemMeta!
parent	UserCatalogItem	The parent item in the hierarchy. Null for root items.
children	UserCatalogItemConnection!	The child items in the hierarchy.

Catalog

A catalog definition that contains catalog items. Catalogs are themselves catalog items.

Implements: CatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!
version	Int!
title	String!
code	Code!
order	Int!
catalog	Catalog!	Self-reference for the meta-catalog.
organization	Organization
meta	CatalogItemMeta!
module	Module!	The module this catalog is associated with.
items	CatalogItemConnection!	The items in this catalog.

Other

SystemActor

The built-in system actor used for automated operations.

Implements: Actor, Node, Titled

Field	Type	Description
id	ID!
title	String!

GeoPoint

A geographic coordinate point.

Field	Type	Description
lat	Latitude!	The latitude coordinate in decimal degrees.
lng	Longitude!	The longitude coordinate in decimal degrees.
altitude	Float	The altitude in meters above sea level.
accuracy	Float	The horizontal accuracy in meters.

PointContainmentResult

The result of checking whether a point is contained within a geometry.

Field	Type	Description
index	Int!	The index of the point in the input array (0-based).
point	GeoPoint!	The point that was checked.
isContained	Boolean!	Whether the point is inside the geometry.