> 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/actors/integrations.md).
# Integrations
{% 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 %}
Integration accounts for API clients, automated systems, and third-party service connections.
## Queries
### integration
Retrieves an integration by its ID.
```graphql
integration(id: ID!): Integration
```
**Arguments**
| Name | Type | Description |
| ---- | ----- | -------------------------------------- |
| `id` | `ID!` | The ID of the integration to retrieve. |
**Output types:**
Integration
An external system integration with API access.
**Implements:** [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor), [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. |
| `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 display name of the actor. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization this integration belongs to. |
| `credentialRef` | `String` | A reference to credentials stored in a secure vault. |
| `isActive` | `Boolean!` | Whether this integration is active. |
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. |
***
### integrations
Lists integrations for an organization.
```graphql
integrations(
organizationId: ID!
filter: IntegrationFilter
first: Int
after: String
last: Int
before: String
orderBy: IntegrationOrder = { field: TITLE, direction: ASC }
): IntegrationConnection!
```
**Arguments**
| Name | Type | Description |
| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------ |
| `organizationId` | `ID!` | The organization to retrieve integrations for. |
| `filter` | `IntegrationFilter` | Filtering options for the returned integrations. |
| `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` | `IntegrationOrder` | The ordering options for the returned integrations. |
**Input types:**
IntegrationFilter
Filtering options for integrations.
| Field | Type | Description |
| ---------- | --------- | ------------------------ |
| `isActive` | `Boolean` | Filter by active status. |
IntegrationOrder
Ordering options for integrations.
| Field | Type | Description |
| ----------- | ----------------------------------------------------------------------------------------------- | ----------------------- |
| `field` | [IntegrationOrderField](#type-integrationorderfield)! | The field to order by. |
| `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. |
**Output types:**
IntegrationConnection
A paginated list of Integration items.
**Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection)
| Field | Type | Description |
| ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| `edges` | \[[IntegrationEdge](#type-integrationedge)!]! | A list of edges. |
| `nodes` | \[[Integration](#type-integration)!]! | 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. |
***
## Mutations
### integrationCreate
Creates a new integration.
```graphql
integrationCreate(
input: IntegrationCreateInput!
): IntegrationPayload
```
**Arguments**
| Name | Type | Description |
| ------- | ------------------------- | ---------------------------------------------- |
| `input` | `IntegrationCreateInput!` | The input fields for creating the integration. |
**Input types:**
IntegrationCreateInput
Input for creating a new integration.
| Field | Type | Description |
| ---------------- | --------- | ----------------------------------------------- |
| `organizationId` | `ID!` | The organization that will own the integration. |
| `title` | `String!` | The display name. |
| `credentialRef` | `String` | A reference to credentials in a secure vault. |
**Output types:**
IntegrationPayload
The result of an integration mutation.
| Field | Type | Description |
| ------------- | --------------------------------- | ----------------------------------- |
| `integration` | [Integration](#type-integration)! | The created or updated integration. |
Integration (entity)
An external system integration with API access.
**Implements:** [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor), [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. |
| `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 display name of the actor. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization this integration belongs to. |
| `credentialRef` | `String` | A reference to credentials stored in a secure vault. |
| `isActive` | `Boolean!` | Whether this integration is active. |
***
### integrationUpdate
Updates an existing integration.
```graphql
integrationUpdate(
input: IntegrationUpdateInput!
): IntegrationPayload
```
**Arguments**
| Name | Type | Description |
| ------- | ------------------------- | ---------------------------------------------- |
| `input` | `IntegrationUpdateInput!` | The input fields for updating the integration. |
**Input types:**
IntegrationUpdateInput
Input for updating an existing integration.
| Field | Type | Description |
| --------------- | --------- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The integration ID to update. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `credentialRef` | `String` | The new credential reference. |
| `isActive` | `Boolean` | The new active status. |
**Output types:**
IntegrationPayload
The result of an integration mutation.
| Field | Type | Description |
| ------------- | --------------------------------- | ----------------------------------- |
| `integration` | [Integration](#type-integration)! | The created or updated integration. |
Integration (entity)
An external system integration with API access.
**Implements:** [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor), [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. |
| `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 display name of the actor. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization this integration belongs to. |
| `credentialRef` | `String` | A reference to credentials stored in a secure vault. |
| `isActive` | `Boolean!` | Whether this integration is active. |
***
### integrationDelete
Deletes an integration.
```graphql
integrationDelete(
input: IntegrationDeleteInput!
): DeletePayload
```
**Arguments**
| Name | Type | Description |
| ------- | ------------------------- | ---------------------------------------------- |
| `input` | `IntegrationDeleteInput!` | The input fields for deleting the integration. |
**Input types:**
IntegrationDeleteInput
Input for deleting an integration.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The integration ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
**Output types:**
DeletePayload
The result of a delete mutation.
| Field | Type | Description |
| ----------- | ----- | ----------------------------- |
| `deletedId` | `ID!` | The ID of the deleted entity. |
***
## Objects
### Integration
An external system integration with API access.
**Implements:** [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor), [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. |
| `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 display name of the actor. |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)! | The organization this integration belongs to. |
| `credentialRef` | `String` | A reference to credentials stored in a secure vault. |
| `isActive` | `Boolean!` | Whether this integration is active. |
***
### IntegrationPayload
The result of an integration mutation.
| Field | Type | Description |
| ------------- | --------------------------------- | ----------------------------------- |
| `integration` | [Integration](#type-integration)! | The created or updated integration. |
***
## Inputs
### IntegrationFilter
Filtering options for integrations.
| Field | Type | Description |
| ---------- | --------- | ------------------------ |
| `isActive` | `Boolean` | Filter by active status. |
***
### IntegrationOrder
Ordering options for integrations.
| Field | Type | Description |
| ----------- | ----------------------------------------------------------------------------------------------- | ----------------------- |
| `field` | [IntegrationOrderField](#type-integrationorderfield)! | The field to order by. |
| `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. |
***
### IntegrationCreateInput
Input for creating a new integration.
| Field | Type | Description |
| ---------------- | --------- | ----------------------------------------------- |
| `organizationId` | `ID!` | The organization that will own the integration. |
| `title` | `String!` | The display name. |
| `credentialRef` | `String` | A reference to credentials in a secure vault. |
***
### IntegrationUpdateInput
Input for updating an existing integration.
| Field | Type | Description |
| --------------- | --------- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The integration ID to update. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `credentialRef` | `String` | The new credential reference. |
| `isActive` | `Boolean` | The new active status. |
***
### IntegrationDeleteInput
Input for deleting an integration.
| Field | Type | Description |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id` | `ID!` | The integration ID to delete. |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
***
## Enums
### IntegrationOrderField
Fields available for ordering integrations.
| Value | Description |
| ------- | --------------- |
| `TITLE` | Order by title. |
***
## Pagination types
### IntegrationConnection
A paginated list of Integration items.
**Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection)
| Field | Type | Description |
| ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| `edges` | \[[IntegrationEdge](#type-integrationedge)!]! | A list of edges. |
| `nodes` | \[[Integration](#type-integration)!]! | 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. |
***
### IntegrationEdge
An edge in the Integration connection.
**Implements:** [Edge](/docs/navixy-repository-api/core-api-reference/common.md#type-edge)
| Field | Type | Description |
| -------- | --------------------------------- | --------------------------------------- |
| `cursor` | `String!` | An opaque cursor for this edge. |
| `node` | [Integration](#type-integration)! | The integration at the end of the edge. |
***
---
# 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/actors/integrations.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.