> 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-repository-api/core-api-reference/catalogs/system.md).

# System catalogs

{% 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 %}

System-defined catalog items that cannot be modified by users.

## Objects

### Module

A system module that groups related functionality and permission scopes. Examples: repo (core), fleet\_management (FSM), iot (devices), reports, billing.

**Implements:** [CatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitem), [Node](/docs/navixy-repository-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#titled)

| Field          | Type                                                                                                              | Description                                                                     |
| -------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `id`           | `ID!`                                                                                                             | A globally unique identifier.                                                   |
| `version`      | `Int!`                                                                                                            | The version number for optimistic locking.                                      |
| `title`        | `String!`                                                                                                         | The human-readable display name. Can be localized.                              |
| `code`         | `Code!`                                                                                                           | A machine-readable code, unique within the catalog scope.                       |
| `order`        | `Int!`                                                                                                            | The display order within the same level or category.                            |
| `catalog`      | [Catalog](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#catalog)!                      | The catalog this item belongs to.                                               |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#organization)                      | The organization that owns this item. Null for system items.                    |
| `meta`         | [CatalogItemMeta](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |

***

### EntityType

A definition of an entity type in the system.

**Implements:** [CatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitem), [Node](/docs/navixy-repository-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#titled)

| Field                    | Type                                                                                                                | Description                                                                     |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `id`                     | `ID!`                                                                                                               | A globally unique identifier.                                                   |
| `version`                | `Int!`                                                                                                              | The version number for optimistic locking.                                      |
| `title`                  | `String!`                                                                                                           | The human-readable display name. Can be localized.                              |
| `code`                   | `Code!`                                                                                                             | A machine-readable code, unique within the catalog scope.                       |
| `order`                  | `Int!`                                                                                                              | The display order within the same level or category.                            |
| `catalog`                | [Catalog](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#catalog)!                        | The catalog this item belongs to.                                               |
| `organization`           | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#organization)                        | The organization that owns this item. Null for system items.                    |
| `meta`                   | [CatalogItemMeta](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemmeta)!   | Metadata about this item including description, origin, and display properties. |
| `uuidDiscriminator`      | `String!`                                                                                                           | The 4-character code embedded in UUIDs for entities of this type.               |
| `isCustomizable`         | `Boolean!`                                                                                                          | Whether entities of this type support custom fields.                            |
| `customFieldDefinitions` | \[[CustomFieldDefinition](/docs/navixy-repository-api/core-api-reference/custom-fields.md#customfielddefinition)!]! | Custom field definitions for entities of this type, ordered by display order.   |

***

### Country

A country reference data item.

**Implements:** [CatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitem), [Node](/docs/navixy-repository-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#titled)

| Field          | Type                                                                                                              | Description                                                                     |
| -------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `id`           | `ID!`                                                                                                             | A globally unique identifier.                                                   |
| `version`      | `Int!`                                                                                                            | The version number for optimistic locking.                                      |
| `title`        | `String!`                                                                                                         | The human-readable display name. Can be localized.                              |
| `code`         | `Code!`                                                                                                           | A machine-readable code, unique within the catalog scope.                       |
| `order`        | `Int!`                                                                                                            | The display order within the same level or category.                            |
| `catalog`      | [Catalog](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#catalog)!                      | The catalog this item belongs to.                                               |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#organization)                      | The organization that owns this item. Null for system items.                    |
| `meta`         | [CatalogItemMeta](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `alpha2Code`   | `CountryCode!`                                                                                                    | The [ISO 3166](https://www.iso.org/standard/3166.html)-1 alpha-2 country code.  |

***


---

# 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-repository-api/core-api-reference/catalogs/system.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.
