Queries

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.

geoObjectTypes

Lists geo object types for an organization.

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.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
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!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

GeoObjectTypeConnection

A paginated list of GeoObjectType items.

Implements: Connection

Field	Type	Description
edges	[GeoObjectTypeEdge!]!	A list of edges.
nodes	[GeoObjectType!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	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.

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, Titled, Customizable, 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. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this geo object.
type	GeoObjectType!	The geo object type classification.
geojsonData	GeoJSON!	The geographic shape of this object as GeoJSON geometry. This is an alias for the geojson_data custom field.
customFields	JSON!	Custom field values as a key-value map. Keys are CustomFieldDefinition codes.
containsPoints	[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, Versioned, 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. Must be provided in update/delete mutations to prevent lost updates.
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!]!	The feature flags enabled for this organization.
parent	Organization	The parent organization in the hierarchy. Null for root organizations.
children	OrganizationConnection!	The child organizations.
members	MemberConnection!	The members of this organization.
devices	DeviceConnection!	The devices owned by this organization.
assets	AssetConnection!	The assets owned by this organization.
geoObjects	GeoObjectConnection!	The geographic objects owned by this organization.
schedules	ScheduleConnection!	The schedules owned by this organization.

---

geoObjects

Lists geo objects for an organization.

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.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
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!]	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!	The comparison operator.
value	JSON	The value to compare against. Null for IS_NULL and IS_NOT_NULL operators.

GeoObjectOrder

Ordering options for geo objects.

Field	Type	Description
field	GeoObjectOrderField	The standard field to order by. Mutually exclusive with customFieldCode.
customFieldCode	Code	The custom field code to order by. Mutually exclusive with field.
direction	OrderDirection!	The direction to order.

Output types:

GeoObjectConnection

A paginated list of GeoObject items.

Implements: Connection

Field	Type	Description
edges	[GeoObjectEdge!]!	A list of edges.
nodes	[GeoObject!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	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.

---