# Overview

{% hint style="warning" %}
**Navixy Repository 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 %}

**Navixy Repository API** is a programming interface for managing the organizational structure and business entities of the Navixy platform. It provides a flexible way to define what you track (assets), how data is collected (devices), where important points are located (geo objects), when things happen (schedules), and who can access what (permissions).

**Navixy Repository is based on GraphQL.** Unlike REST APIs where you call multiple endpoints to gather related data, GraphQL allows you to request the exact fields you need in a single query. You describe the shape of the data you want, and the API returns it in that shape.

For a quick description of GraphQL concepts, see [GraphQL basics](https://www.navixy.com/docs/navixy-repository-api/graphql-basics).

## Purpose and capabilities

**Navixy Repository API** enables you to:

* Create **assets** and organize them into **groups**
* Register **devices** (GPS trackers, sensors) with hardware identifiers and add them to **inventories**
* Define **geo objects** (geofences, points of interest, routes) with GeoJSON geometry
* Create **schedules** for work hours, maintenance windows, and time-based rules
* Configure **custom fields** to extend certain entities with organization-specific data

## Key concepts

<figure><img src="https://2533405873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeaPUYn5ATRhY1fALtOkq%2Fuploads%2Fgit-blob-c1d05649898f941198f7426f29d72297515ca872%2Fimage%20(2).png?alt=media" alt=""><figcaption></figcaption></figure>

The API is organized around the following core resources:

<table><thead><tr><th width="147.48895263671875">Term</th><th>Definition</th></tr></thead><tbody><tr><td><strong>Organization</strong></td><td>The main tenant in the system hierarchy. Organizations own all other resources.</td></tr><tr><td><strong>Asset</strong></td><td>A business object you're tracking: a vehicle, piece of equipment, employee, or any other entity. Assets can be linked into <strong>asset groups</strong> or assigned one or multiple GPS devices.</td></tr><tr><td><strong>Device</strong></td><td>Physical tracking hardware (GPS tracker, sensor, beacon). Devices have types, models, statuses, and hardware identifiers (IMEI, serial number).</td></tr><tr><td><strong>Inventory</strong></td><td>A logical grouping of devices for stock management (warehouse, vehicle stock, field inventory).</td></tr><tr><td><strong>Geo object</strong></td><td>A location-based entity based on the GeoJSON standard: geofence, point of interest, or route.</td></tr><tr><td><strong>Schedule</strong></td><td>iCalendar-compatible time-based schedules for your operations (maintenance cycles, time shifts).</td></tr></tbody></table>

## Navigation

The **Navixy Repository API documentation** is organized into two complementary sections designed to help you understand concepts and implement solutions.

### Section content

These articles provide essential background knowledge and guidelines:

* [**GraphQL basics**](https://www.navixy.com/docs/navixy-repository-api/graphql-basics): A brief introduction to GraphQL for developers familiar with REST APIs.
* [**GraphQL tips and patterns**](https://www.navixy.com/docs/navixy-repository-api/graphql-basics/graphql-tips-and-patterns): Practical suggestions for improving your GraphQL experience.
* [**Error handling**](https://www.navixy.com/docs/navixy-repository-api/error-handling)**:** Error structure, codes, and common error scenarios.
* [**Pagination** ](https://www.navixy.com/docs/navixy-repository-api/pagination)and [**Filtering and sorting**](https://www.navixy.com/docs/navixy-repository-api/filtering-and-sorting): Instruments for efficient navigating through pages of data and narrowing down results by criteria and order.
* [**Optimistic locking**](https://www.navixy.com/docs/navixy-repository-api/optimistic-locking): How the API handles concurrent updates to prevent conflicting changes from overwriting each other.
* [**Guides**](https://www.navixy.com/docs/navixy-repository-api/guides): In-depth guides exploring the most common use cases.

### Core API reference

The API reference provides complete technical specifications for all GraphQL types and operations, grouped by category:

* [**Common resources**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/common)
* [**Directives**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/directives)
* [**Organizations**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/organizations)
* [**Actors**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/actors)
* [**Devices**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/devices)
* [**Assets**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/assets)
* [**Geo objects**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/geo-objects)
* [**Schedules**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/schedules)
* [**Access control**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/access-control)
* [**Custom fields**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/custom-fields)
* [**Audit**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/audit)
* [**Catalogs**](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/catalogs)

{% hint style="warning" %}
The API supports [GraphQL introspection](https://www.navixy.com/docs/navixy-repository-api/graphql-basics#the-schema) for authenticated users. You can perform it via [Navixy Repository GraphQL Sandbox](https://api.navixy.dev/v4/graphql/sandbox) (currently in query-only demo mode) or with your own tools. You can also check the public [GraphQL schema](https://raw.githubusercontent.com/SquareGPS/navixy-api/refs/heads/nvx4-clean/docs/navixy-repository-api/graphql-schema/schema.graphql).
{% endhint %}