Organizations
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.
Organizations form the top-level container for all business data. Each organization operates as an isolated tenant with its own users, devices, assets, and configuration.
Queries
organization
Retrieves an organization by its ID.
organization(id: ID!): OrganizationArguments
id
ID!
The ID of the organization to retrieve.
Output types:
Organization
An organization in the hierarchy that owns entities and users.
Implements: Node, Versioned, Titled
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.
OrganizationConnection (entity)
organizations
Lists organizations.
Arguments
filter
OrganizationFilter
Filtering options for the returned organizations.
orderBy
OrganizationOrder
The ordering options for the returned organizations.
Input types:
OrganizationFilter
Filtering options for organizations.
parentIds
[ID!]
Filter by parent organizations (OR within field).
isActive
Boolean
Filter by active status.
Output types:
OrganizationConnection
PageInfo (entity)
Information about the current page in a paginated connection.
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
organizationCreate
Creates a new organization.
Arguments
input
OrganizationCreateInput!
The input fields for creating the organization.
Input types:
OrganizationCreateInput
Input for creating a new organization.
parentId
ID
The parent organization ID. Null for root organizations.
title
String!
The display name.
externalId
String
An external system identifier.
Output types:
Organization (entity)
An organization in the hierarchy that owns entities and users.
Implements: Node, Versioned, Titled
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.
organizationUpdate
Updates an existing organization.
Arguments
input
OrganizationUpdateInput!
The input fields for updating the organization.
Input types:
OrganizationUpdateInput
Input for updating an existing organization.
id
ID!
The organization ID to update.
version
Int!
The current version for optimistic locking.
title
String
The new display name.
externalId
String
The new external identifier.
isActive
Boolean
The new active status.
Output types:
Organization (entity)
An organization in the hierarchy that owns entities and users.
Implements: Node, Versioned, Titled
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.
organizationDelete
Deletes an organization and all its data.
Arguments
input
OrganizationDeleteInput!
The input fields for deleting the organization.
Input types:
OrganizationDeleteInput
Input for deleting an organization and all its data.
id
ID!
The organization ID to delete.
version
Int!
The current version for optimistic locking.
Output types:
DeletePayload
The result of a delete mutation.
deletedId
ID!
The ID of the deleted entity.
Objects
Organization
An organization in the hierarchy that owns entities and users.
Implements: Node, Versioned, Titled
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.
OrganizationPayload
The result of an organization mutation.
Inputs
OrganizationFilter
Filtering options for organizations.
parentIds
[ID!]
Filter by parent organizations (OR within field).
isActive
Boolean
Filter by active status.
OrganizationChildrenFilter
Filtering options for organization children. Excludes parentId as it is implicit.
isActive
Boolean
Filter by active status.
titleContains
String
Partial match on title (case-insensitive contains).
OrganizationOrder
Ordering options for organizations.
OrganizationCreateInput
Input for creating a new organization.
parentId
ID
The parent organization ID. Null for root organizations.
title
String!
The display name.
externalId
String
An external system identifier.
OrganizationUpdateInput
Input for updating an existing organization.
id
ID!
The organization ID to update.
version
Int!
The current version for optimistic locking.
title
String
The new display name.
externalId
String
The new external identifier.
isActive
Boolean
The new active status.
OrganizationDeleteInput
Input for deleting an organization and all its data.
id
ID!
The organization ID to delete.
version
Int!
The current version for optimistic locking.
Enums
OrganizationFeature
Feature flags that can be enabled for an organization.
DEALER
The organization can create and manage child organizations (dealer/reseller model).
WHITELABEL
The organization has custom branding including domain, logo, and color scheme.
OrganizationOrderField
Fields available for ordering organizations.
TITLE
Order by title.
Pagination types
OrganizationConnection
A paginated list of Organization items.
Implements: Connection
OrganizationEdge
An edge in the Organization connection.
Implements: Edge
cursor
String!
An opaque cursor for this edge.
Last updated
Was this helpful?