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

## 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="/files/xexoZtVsKr1epPxCzr8m" 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**](/docs/navixy-repository-api/graphql-basics.md): A brief introduction to GraphQL for developers familiar with REST APIs.
* [**GraphQL tips and patterns**](/docs/navixy-repository-api/graphql-basics/graphql-tips-and-patterns.md): Practical suggestions for improving your GraphQL experience.
* [**Error handling**](/docs/navixy-repository-api/error-handling.md)**:** Error structure, codes, and common error scenarios.
* [**Pagination** ](/docs/navixy-repository-api/pagination.md)and [**Filtering and sorting**](/docs/navixy-repository-api/filtering-and-sorting.md): Instruments for efficient navigating through pages of data and narrowing down results by criteria and order.
* [**Optimistic locking**](/docs/navixy-repository-api/optimistic-locking.md): How the API handles concurrent updates to prevent conflicting changes from overwriting each other.
* [**Guides**](/docs/navixy-repository-api/guides.md): 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**](/docs/navixy-repository-api/core-api-reference/common.md)
* [**Directives**](/docs/navixy-repository-api/core-api-reference/directives.md)
* [**Organizations**](/docs/navixy-repository-api/core-api-reference/organizations.md)
* [**Actors**](/docs/navixy-repository-api/core-api-reference/actors.md)
* [**Devices**](/docs/navixy-repository-api/core-api-reference/devices.md)
* [**Assets**](/docs/navixy-repository-api/core-api-reference/assets.md)
* [**Geo objects**](/docs/navixy-repository-api/core-api-reference/geo-objects.md)
* [**Schedules**](/docs/navixy-repository-api/core-api-reference/schedules.md)
* [**Access control**](/docs/navixy-repository-api/core-api-reference/access-control.md)
* [**Custom fields**](/docs/navixy-repository-api/core-api-reference/custom-fields.md)
* [**Audit**](/docs/navixy-repository-api/core-api-reference/audit.md)
* [**Catalogs**](/docs/navixy-repository-api/core-api-reference/catalogs.md)

{% hint style="warning" %}
The API supports [GraphQL introspection](/docs/navixy-repository-api/graphql-basics.md#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 %}


---

# Agent Instructions: 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:

```
GET https://navixy.com/docs/navixy-repository-api/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.