Core API reference
How the Navixy GraphQL API reference is organized: the types shared across products, then one page per category within each product.
The Core API reference documents every operation and type of Navixy GraphQL API, grouped into one page per category. Each category page covers its queries, mutations, input and object types, and enums, with a field table for every type.
The reference states what each operation and field is. For how to use them together, see the guides in each product section, and for the GraphQL fundamentals behind the notation, see GraphQL basics, including the type syntax that the field tables use.
Shared across products
These two pages belong to no single product. Every product of Navixy GraphQL API uses what they document.
The node/nodes lookup queries, the shared scalars (Code, DateTime, Long, Decimal, JSON, HexColorCode), the interfaces (Node, Titled, Versioned, Customizable), the Money value type with its Currency scalar (used by Billing), and the pagination types (PageInfo, CountInfo).
The standard GraphQL directives plus the custom @trim.
Business Data Repository
Entry point: bdr. The Business Data Repository API reference page introduces these categories, and the product overview says what the product covers and how to start.
Workspace (read-only: Navixy Console owns the lifecycle) and members (Member, member CRUD).
The Actor interface, with users (User, memberships, user catalog items) and integrations (Integration, service accounts).
Device, DeviceIdentifier, DeviceRelation, the device type/model/vendor/status catalogs, and inventory (Inventory, assignment history).
Asset and AssetType, plus asset groups (AssetGroup, AssetGroupType, and AssetGroupItem membership history).
GeoObject and GeoObjectType for geofences, points of interest, and routes, with GeoJSON geometry.
Schedule and the ScheduleData calendar value, compatible with iCalendar.
CustomFieldDefinition, the FieldType catalog, the typed CustomFieldValue variants, and the patch inputs used in create and update mutations.
AuditEvent, the auditEvents and entityHistory queries, and the event and source type enums.
Catalog and catalog items (CatalogItem, hierarchical UserCatalogItem), tags, and system catalogs.
Tracking
Entry point: tracking for queries, and the Subscription root for the state stream. The Tracking API reference page introduces these pages, and the product overview says what the product covers.
TrackingDeviceState and TrackingAssetState, with the deviceState, deviceStates, assetState, and assetStates queries and their filter and order inputs.
The subscription that pushes the full state of an asset, with its linked devices, on every report, in batches with opening-snapshot markers and removal signals.
TrackingReading and its typed values, the unit rules, and the field dictionary with fieldDefinitions.
deviceTimeline and assetTimeline, the segmentation policy that cuts a timeline into trips and stops, and the options that shape the returned points.
IoT Logic
Entry point: iotLogic for queries and mutations. The IoT Logic API reference page introduces this page, and the product overview says what the product covers and how to start.
IotLogicFlow, the IotLogicFlowNode interface with its node types, and IotLogicFlowTransition, with the flow, flows, and flowDebugValues queries and the flowCreate, flowUpdate, and flowDelete mutations.
Billing
Entry point: billing. The Billing API reference page introduces these pages and says how every operation acts in the workspace named by the token, and the product overview says what the product covers and how to start.
BillingAvailablePlan and BillingAvailablePlanItem, with the myAvailablePlans query, and the catalog and pricing types a plan is built from: BillingProductDomain, BillingMetric, BillingPricingModel, BillingAggregationFunction, BillingUsagePricing, and BillingUsagePricingTier.
BillingWorkspaceSubscription, with the mySubscribe mutation, the mySubscriptions query, and their filter and order inputs.
BillingBalance and BillingBalanceEntry, with the myBalance and myBalanceEntries queries.
BillingUsageMetricSubmission and BillingInvoiceLineItemSubmission, with the myUsageMetricSubmissions and myInvoiceLineItemSubmissions queries that read what products reported for your workspace.
Console
Entry point: console. The Console API reference page introduces these pages and says how their connections paginate. Their pagination differs from the other products'.
ConsoleOrganization and the accessibleOrganizations query, with its connection and edge types.
ConsoleWorkspace and the accessibleWorkspaces query, with its connection and edge types.
ConsoleWorkspaceProduct, ConsoleProductCatalogEntry, and ConsoleWorkspaceOperation, with the workspaceProducts, productCatalog, and workspaceOperation queries and the workspaceProductEnable and workspaceProductDisable mutations.
IAM
Entry point: iam. The IAM API reference page introduces these pages, says what a caller needs to call them, and says how their lists paginate. Their pagination differs from the other products'.
IamRole, with the roles, role, and workspaceRoles queries and the roleCreate, roleUpdate, and roleDelete mutations.
What a role grants: IamSelection, IamRoleProductScopes, IamRoleProductScope, IamRoleDataResources, IamRoleDataResourceGrant, and IamRoleItemActions, with their input types.
IamMemberRoleAssignment and IamRoleHolder, with the memberRoles and roleHolders queries and the memberRoleAssign and memberRoleRevoke mutations.
How the reference pages are structured
Every category page follows the same order: queries, then mutations, then the category's objects, inputs, and enums, with pagination types in a section of their own at the end. Field tables use the GraphQL type notation, where ! marks a value that is never null and [...] marks a list: see Type syntax.
Other ways to explore the API
Public GraphQL schema: The full type system split into several files.
Introspection: Explore the schema from your own GraphQL client.
See also
GraphQL basics: Learn GraphQL fundamentals, from queries and mutations to the type system
Limits: Request rate, subscription, pagination, and input size limits, and the errors they return
Error handling: Understand error structure, codes, and common error scenarios
Last updated
Was this helpful?