> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-graphql-api/core-api-reference.md).

# 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](/docs/navixy-graphql-api/graphql-basics.md), including the [type syntax](/docs/navixy-graphql-api/graphql-basics.md#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.

<table><thead><tr><th width="212">Page</th><th>Covers</th></tr></thead><tbody><tr><td><a href="/docs/navixy-graphql-api/core-api-reference/common.md">Common resources</a></td><td>The <code>node</code>/<code>nodes</code> lookup queries, the shared scalars (<code>Code</code>, <code>DateTime</code>, <code>Long</code>, <code>Decimal</code>, <code>JSON</code>, <code>HexColorCode</code>), the interfaces (<code>Node</code>, <code>Titled</code>, <code>Versioned</code>, <code>Customizable</code>), and the pagination types (<code>PageInfo</code>, <code>CountInfo</code>).</td></tr><tr><td><a href="/docs/navixy-graphql-api/core-api-reference/directives.md">Directives</a></td><td>The standard GraphQL directives plus the custom <code>@trim</code>.</td></tr></tbody></table>

## Business Data Repository

Entry point: `bdr`. The [Business Data Repository API reference](/docs/navixy-graphql-api/business-data-repository/api-reference.md) page introduces these categories, and the [product overview](/docs/navixy-graphql-api/business-data-repository/overview.md) says what the product covers and how to start.

<table><thead><tr><th width="186">Category</th><th>Covers</th></tr></thead><tbody><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md">Workspaces</a></td><td><code>Workspace</code> (read-only: Navixy Console owns the lifecycle) and <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces/members.md">members</a> (<code>Member</code>, member CRUD).</td></tr><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/actors.md">Actors</a></td><td>The <code>Actor</code> interface, with <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/actors/users.md">users</a> (<code>User</code>, memberships, user catalog items) and <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/actors/integrations.md">integrations</a> (<code>Integration</code>, service accounts).</td></tr><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/devices.md">Devices</a></td><td><code>Device</code>, <code>DeviceIdentifier</code>, <code>DeviceRelation</code>, the device type/model/vendor/status catalogs, and <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/devices/inventory.md">inventory</a> (<code>Inventory</code>, assignment history).</td></tr><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/assets.md">Assets</a></td><td><code>Asset</code> and <code>AssetType</code>, plus <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/assets/groups.md">asset groups</a> (<code>AssetGroup</code>, <code>AssetGroupType</code>, and <code>AssetGroupItem</code> membership history).</td></tr><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/geo-objects.md">Geo objects</a></td><td><code>GeoObject</code> and <code>GeoObjectType</code> for geofences, points of interest, and routes, with GeoJSON geometry and the <code>containsPoints</code> check.</td></tr><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/schedules.md">Schedules</a></td><td><code>Schedule</code> and the <code>ScheduleData</code> calendar value, compatible with iCalendar.</td></tr><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/custom-fields.md">Custom fields</a></td><td><code>CustomFieldDefinition</code>, the <code>FieldType</code> catalog, the typed <code>CustomFieldValue</code> variants, and the patch inputs used in create and update mutations.</td></tr><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/audit.md">Audit</a></td><td><code>AuditEvent</code>, the <code>auditEvents</code> and <code>entityHistory</code> queries, and the event and source type enums.</td></tr><tr><td><a href="/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs.md">Catalogs</a></td><td><code>Catalog</code> and <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-items.md">catalog items</a> (<code>CatalogItem</code>, hierarchical <code>UserCatalogItem</code>), <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/tags.md">tags</a>, and <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/system.md">system catalogs</a>.</td></tr></tbody></table>

## Tracking

Entry point: `tracking` for queries, and the `Subscription` root for the two state streams. The [Tracking API reference](/docs/navixy-graphql-api/tracking/api-reference.md) page introduces these pages, and the [product overview](/docs/navixy-graphql-api/tracking/overview.md) says what the product covers.

<table><thead><tr><th width="240">Page</th><th>Covers</th></tr></thead><tbody><tr><td><a href="/docs/navixy-graphql-api/tracking/api-reference/state.md">Live state</a></td><td><code>TrackingDeviceState</code> and <code>TrackingAssetState</code>, with the <code>deviceState</code>, <code>deviceStates</code>, <code>assetState</code>, and <code>assetStates</code> queries and their filter and order inputs.</td></tr><tr><td><a href="/docs/navixy-graphql-api/tracking/api-reference/state/streams.md">State streams</a></td><td>The subscriptions that push the full state of an asset or a device on every report, in batches with opening-snapshot markers and removal signals.</td></tr><tr><td><a href="/docs/navixy-graphql-api/tracking/api-reference/readings.md">Readings and the field dictionary</a></td><td><code>TrackingReading</code> and its typed values, the unit rules, and the field dictionary with <code>hotFieldCodes</code> and <code>fieldDefinitions</code>.</td></tr><tr><td><a href="/docs/navixy-graphql-api/tracking/api-reference/trips.md">Trips and stops</a></td><td><code>deviceTimeline</code> and <code>assetTimeline</code>, the segmentation policy that cuts a timeline into trips and stops, and the options that shape the returned points.</td></tr></tbody></table>

## Other products

IoT Logic, Alerts, and Reports are in preparation. Their reference pages will appear here as each product becomes available.

## 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](/docs/navixy-graphql-api/graphql-basics.md#type-syntax).

## Other ways to explore the API

* [GraphQL Sandbox](https://api.navixy.dev/v4/graphql/sandbox): Run queries and mutations interactively.
* [Public GraphQL schema](/docs/navixy-graphql-api/developer-resources/public-graphql-schema.md): The full type system split into several files.
* [Introspection](/docs/navixy-graphql-api/graphql-basics.md#introspection): Explore the schema from your own GraphQL client.

## See also

* [GraphQL basics](/docs/navixy-graphql-api/graphql-basics.md): Learn GraphQL fundamentals, from queries and mutations to the type system
* [Limits](/docs/navixy-graphql-api/limits.md): Request, pagination, and input size limits, and the errors they return
* [Error handling](/docs/navixy-graphql-api/error-handling.md): Understand error structure, codes, and common error scenarios


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-graphql-api/core-api-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.