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.

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, and for the GraphQL fundamentals behind the notation, see GraphQL basics, including the 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 operation acts in the workspace that your access token names, so no query or mutation takes a workspace ID. For what the product covers and how to start, see the product overview.

Categories

Category	Covers
Workspaces	Workspace (read-only: Navixy Console owns the lifecycle) and members (Member, member CRUD).
Actors	The Actor interface, with users (User, memberships, user catalog items) and integrations (Integration, service accounts).
Devices	Device, DeviceIdentifier, DeviceRelation, the device type/model/vendor/status catalogs, and inventory (Inventory, assignment history).
Assets	Asset and AssetType, plus asset groups (AssetGroup, AssetGroupType, and AssetGroupItem membership history).
Geo objects	GeoObject and GeoObjectType for geofences, points of interest, and routes, with GeoJSON geometry.
Schedules	Schedule and the ScheduleData calendar value, compatible with iCalendar.
Custom fields	CustomFieldDefinition, the FieldType catalog, the typed CustomFieldValue variants, and the patch inputs used in create and update mutations.
Audit	AuditEvent, the auditEvents and entityHistory queries, and the event and source type enums.
Catalogs	Catalog and catalog items (CatalogItem, hierarchical UserCatalogItem), tags, system catalogs, and the catalog reference that says which catalog backs a given field.

Shared types

The scalars, interfaces, and pagination types that Business Data Repository shares with the other products are on the Common resources page. Filtering by custom field values is on Custom field filtering and sorting. The Core API reference 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.

Other ways to explore the API

• GraphQL Sandbox: Run queries and mutations interactively.

• Public GraphQL schema: The full type system split into several files.

• Introspection: Explore the schema from your own GraphQL client.

See also

• Business Data Repository overview: What the product covers and how to start

• Business Data Repository guides: Scenario walkthroughs built from these operations

• Optimistic locking: The version check that update and delete mutations make when you send version

• Error handling: Understand error structure, codes, and common error scenarios