> 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/business-data-repository/api-reference.md).

# Business Data Repository API reference

How the Business Data Repository reference is organized: one page per category for workspaces, actors, devices, assets, geo objects, schedules, custom fields, audit, and catalogs.

{% hint style="warning" %}
**Navixy GraphQL API is a work in progress.** This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.
{% endhint %}

The Business Data Repository API reference documents every operation and type of Business Data Repository, 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 [Business Data Repository guides](/docs/navixy-graphql-api/business-data-repository/guides.md), 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.

## Where the operations live

All Business Data Repository queries and mutations are nested under the `bdr` field of the `Query` and `Mutation` types, and every response has the same shape under `data.bdr`. Every query and mutation that lists or creates entities takes a `workspaceId` argument. For what the product covers and how to start, see the [product overview](/docs/navixy-graphql-api/business-data-repository/overview.md).

## Categories

<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>, <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/system.md">system catalogs</a>, and the <a href="/docs/navixy-graphql-api/business-data-repository/api-reference/catalogs/catalog-reference.md">catalog reference</a> that says which catalog backs a given field.</td></tr></tbody></table>

## Shared types

The scalars, interfaces, and pagination types that Business Data Repository shares with the other products are on the [Common resources](/docs/navixy-graphql-api/core-api-reference/common.md) page. Filtering by custom field values is on [Custom field filtering and sorting](/docs/navixy-graphql-api/filtering-and-sorting/custom-field-filtering.md). The [Core API reference](/docs/navixy-graphql-api/core-api-reference.md) indexes the reference pages of every product.

## 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

* [Business Data Repository overview](/docs/navixy-graphql-api/business-data-repository/overview.md): What the product covers and how to start
* [Business Data Repository guides](/docs/navixy-graphql-api/business-data-repository/guides.md): Scenario walkthroughs built from these operations
* [Optimistic locking](/docs/navixy-graphql-api/optimistic-locking.md): The version check that every update and delete mutation makes
* [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/business-data-repository/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.