> 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/geo-objects/queries.md).
# Queries
{% 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 %}
### geoObjectTypes
Lists geo object types for an organization.
```graphql
geoObjectTypes(
organizationId: ID!
filter: CatalogItemFilter
first: Int
after: String
last: Int
before: String
orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
): GeoObjectTypeConnection!
```
**Arguments**
| Name | Type | Description |
| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------ |
| `organizationId` | `ID!` | The organization to retrieve geo object types for. |
| `filter` | `CatalogItemFilter` | Filtering options for the returned geo object types. |
| `first` | `Int` | The first `n` elements from the [paginated list](/docs/navixy-repository-api/pagination.md). |
| `after` | `String` | The elements that come after the specified [cursor](/docs/navixy-repository-api/pagination.md). |
| `last` | `Int` | The last `n` elements from the [paginated list](/docs/navixy-repository-api/pagination.md). |
| `before` | `String` | The elements that come before the specified [cursor](/docs/navixy-repository-api/pagination.md). |
| `orderBy` | `CatalogItemOrder` | The ordering options for the returned geo object types. |
**Input types:**
CatalogItemFilter
Filtering options for catalog items.
| Field | Type | Description |
| --------------- | --------- | --------------------------------------------------- |
| `titleContains` | `String` | Partial match on title (case-insensitive contains). |
| `codes` | `[Code!]` | Match any of these codes. |
CatalogItemOrder
Ordering options for catalog items.
| Field | Type | Description |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| `field` | [CatalogItemOrderField](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemorderfield)! | The field to order by. |
| `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. |
**Output types:**
GeoObjectTypeConnection
A paginated list of GeoObjectType items.
**Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection)
| Field | Type | Description |
| ---------- | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges` | \[[GeoObjectTypeEdge](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-geoobjecttypeedge)!]! | A list of edges. |
| `nodes` | \[[GeoObjectType](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-geoobjecttype)!]! | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-pageinfo)! | Information about the current page. |
| `total` | [CountInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-countinfo) | The total count of items matching the filter. |
PageInfo (entity)
Information about the current page in a paginated connection.
| Field | Type | Description |
| ----------------- | ---------- | ---------------------------------------------------------- |
| `hasNextPage` | `Boolean!` | Whether more items exist after the current page. |
| `hasPreviousPage` | `Boolean!` | Whether more items exist before the current page. |
| `startCursor` | `String` | The cursor pointing to the first item in the current page. |
| `endCursor` | `String` | The cursor pointing to the last item in the current page. |
***
### geoObject
Retrieves a geo object by its ID.
```graphql
geoObject(id: ID!): GeoObject
```
**Arguments**
| Name | Type | Description |
| ---- | ----- | ------------------------------------- |
| `id` | `ID!` | The ID of the geo object to retrieve. |
**Output types:**
GeoObject
A geographic object such as a geofence, point of interest, or route.
**Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#type-titled), [Customizable](/docs/navixy-repository-api/core-api-reference/common.md#type-customizable), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned)
| Field | Type | Description |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The human-readable display name. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization that owns this geo object. |
| `type` | [GeoObjectType](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-geoobjecttype)! | The geo object type classification. |
| `geojsonData` | `GeoJSON!` | The geographic shape of this object as GeoJSON geometry. |
| `customFields` | `JSON!` | Custom field values as a key-value map. Keys are `CustomFieldDefinition` codes. System-reserved codes (`geojson_data`, `schedule_data`) are excluded from this map and exposed through dedicated typed fields on the entity instead. |
| `containsPoints` | \[[PointContainmentResult](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-pointcontainmentresult)!]! | Checks if the given points are contained within this geo object's geometry. Returns the containment status for each point. Only applicable to Polygon and MultiPolygon geometries. |
Organization (entity)
An organization in the hierarchy that owns entities and users.
**Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#type-titled)
| Field | Type | Description |
| ------------ | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The human-readable display name. |
| `externalId` | `String` | An external system identifier for integration purposes. |
| `isActive` | `Boolean!` | Whether this organization is active. |
| `features` | \[[OrganizationFeature](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organizationfeature)!]! | The feature flags enabled for this organization. |
| `parent` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization) | The parent organization in the hierarchy. Null for root organizations. |
| `children` | [OrganizationConnection](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organizationconnection)! | The child organizations. |
| `members` | [MemberConnection](/docs/navixy-repository-api/core-api-reference/organizations/members.md#type-memberconnection)! | The members of this organization. |
| `devices` | [DeviceConnection](/docs/navixy-repository-api/core-api-reference/devices/types.md#type-deviceconnection)! | The devices owned by this organization. |
| `assets` | [AssetConnection](/docs/navixy-repository-api/core-api-reference/assets/types.md#type-assetconnection)! | The assets owned by this organization. |
| `geoObjects` | [GeoObjectConnection](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-geoobjectconnection)! | The geographic objects owned by this organization. |
| `schedules` | [ScheduleConnection](/docs/navixy-repository-api/core-api-reference/schedules.md#type-scheduleconnection)! | The schedules owned by this organization. |
***
### geoObjects
Lists geo objects for an organization.
```graphql
geoObjects(
organizationId: ID!
filter: GeoObjectFilter
first: Int
after: String
last: Int
before: String
orderBy: GeoObjectOrder = { field: TITLE, direction: ASC }
): GeoObjectConnection!
```
**Arguments**
| Name | Type | Description |
| ---------------- | ----------------- | ------------------------------------------------------------------------------------------------ |
| `organizationId` | `ID!` | The organization to retrieve geo objects for. |
| `filter` | `GeoObjectFilter` | Filtering options for the returned geo objects. |
| `first` | `Int` | The first `n` elements from the [paginated list](/docs/navixy-repository-api/pagination.md). |
| `after` | `String` | The elements that come after the specified [cursor](/docs/navixy-repository-api/pagination.md). |
| `last` | `Int` | The last `n` elements from the [paginated list](/docs/navixy-repository-api/pagination.md). |
| `before` | `String` | The elements that come before the specified [cursor](/docs/navixy-repository-api/pagination.md). |
| `orderBy` | `GeoObjectOrder` | The ordering options for the returned geo objects. |
**Input types:**
GeoObjectFilter
Filtering options for geo objects.
| Field | Type | Description |
| --------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| `typeIds` | `[ID!]` | Filter by geo object types (OR within field). |
| `titleContains` | `String` | Partial match on title (case-insensitive contains). |
| `customFields` | \[[CustomFieldFilter](/docs/navixy-repository-api/core-api-reference/custom-fields.md#type-customfieldfilter)!] | Filter by custom field values. |
CustomFieldFilter
A filter condition for a custom field value.
| Field | Type | Description |
| ---------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `code` | `Code!` | The custom field code to filter by. |
| `operator` | [FieldOperator](/docs/navixy-repository-api/core-api-reference/custom-fields.md#type-fieldoperator)! | The comparison operator. |
| `value` | [CustomFieldFilterValue](/docs/navixy-repository-api/core-api-reference/custom-fields.md#type-customfieldfiltervalue) | The value to compare against. Null for `IS_NULL` and `IS_NOT_NULL` operators. |
CustomFieldFilterValue
Typed filter value for custom fields. Exactly one field must be set (`@oneOf`). Choose the variant that matches the custom field's data type:
| FieldType | Variant | Example |
| --------------------- | ------------ | -------------------------------------- |
| STRING, TEXT | `string` | `{ string: "hello" }` |
| DECIMAL | `decimal` | `{ decimal: "42.50" }` |
| INTEGER | `integer` | `{ integer: 42 }` |
| BOOLEAN | `boolean` | `{ boolean: true }` |
| DATE | `date` | `{ date: "2024-01-15" }` |
| DATETIME | `datetime` | `{ datetime: "2024-01-15T10:30:00Z" }` |
| OPTIONS, CATALOG, TAG | `string` | `{ string: "option_code" }` |
| DEVICE, REFERENCE | `id` | `{ id: "019a6a3f-..." }` |
| (IN operator) | `stringList` | `{ stringList: ["a", "b"] }` |
| (IN operator) | `idList` | `{ idList: ["uuid1", "uuid2"] }` |
*This input type uses `@oneOf` - exactly one field must be provided.*
| Field | Type | Description |
| ------------ | ----------- | -------------------------------------------------------------- |
| `string` | `String` | String value — for STRING, TEXT, OPTIONS, CATALOG, TAG fields. |
| `decimal` | `Decimal` | Arbitrary-precision decimal value — for DECIMAL fields. |
| `integer` | `Long` | Signed 64-bit integer value — for INTEGER fields. |
| `boolean` | `Boolean` | Boolean value — for BOOLEAN fields. |
| `date` | `Date` | Date value — for DATE fields. |
| `datetime` | `DateTime` | Date-time value — for DATETIME fields. |
| `id` | `ID` | ID value — for DEVICE, REFERENCE fields. |
| `stringList` | `[String!]` | List of strings — for IN operator on string-based fields. |
| `idList` | `[ID!]` | List of IDs — for IN operator on reference fields. |
GeoObjectOrder
Ordering options for geo objects.
| Field | Type | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `field` | [GeoObjectOrderField](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-geoobjectorderfield) | The standard field to order by. Mutually exclusive with `customFieldCode`. |
| `customFieldCode` | `Code` | The custom field code to order by. Mutually exclusive with `field`. Supported field types: STRING, TEXT, DECIMAL, INTEGER, DATE, DATETIME. OPTIONS, TAG, BOOLEAN, GEOJSON, SCHEDULE, DEVICE, REFERENCE, CATALOG are not supported for sorting. |
| `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. |
**Output types:**
GeoObjectConnection
A paginated list of GeoObject items.
**Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection)
| Field | Type | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| `edges` | \[[GeoObjectEdge](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-geoobjectedge)!]! | A list of edges. |
| `nodes` | \[[GeoObject](/docs/navixy-repository-api/core-api-reference/geo-objects/types.md#type-geoobject)!]! | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-pageinfo)! | Information about the current page. |
| `total` | [CountInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-countinfo) | The total count of items matching the filter. |
PageInfo (entity)
Information about the current page in a paginated connection.
| Field | Type | Description |
| ----------------- | ---------- | ---------------------------------------------------------- |
| `hasNextPage` | `Boolean!` | Whether more items exist after the current page. |
| `hasPreviousPage` | `Boolean!` | Whether more items exist before the current page. |
| `startCursor` | `String` | The cursor pointing to the first item in the current page. |
| `endCursor` | `String` | The cursor pointing to the last item in the current page. |
***
---
# 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/geo-objects/queries.md?ask=&goal=
```
`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.