Organizations

circle-exclamation

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!): Organization

Arguments

Name
Type
Description

id

ID!

The ID of the organization to retrieve.

Output types:

chevron-rightOrganizationhashtag

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

The feature flags enabled for this organization.

parent

The parent organization in the hierarchy. Null for root organizations.

children

The child organizations.

members

The members of this organization.

devices

The devices owned by this organization.

assets

The assets owned by this organization.

geoObjects

The geographic objects owned by this organization.

schedules

The schedules owned by this organization.

chevron-rightOrganizationConnection (entity)hashtag

A paginated list of Organization items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


organizations

Lists organizations.

Arguments

Name
Type
Description

filter

OrganizationFilter

Filtering options for the returned organizations.

first

Int

The first n elements from the paginated listarrow-up-right.

after

String

The elements that come after the specified cursorarrow-up-right.

last

Int

The last n elements from the paginated listarrow-up-right.

before

String

The elements that come before the specified cursorarrow-up-right.

orderBy

OrganizationOrder

The ordering options for the returned organizations.

Input types:

chevron-rightOrganizationFilterhashtag

Filtering options for organizations.

Field
Type
Description

parentIds

[ID!]

Filter by parent organizations (OR within field).

isActive

Boolean

Filter by active status.

chevron-rightOrganizationOrderhashtag

Ordering options for organizations.

Field
Type
Description

field

The field to order by.

direction

The direction to order.

Output types:

chevron-rightOrganizationConnectionhashtag

A paginated list of Organization items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.

chevron-rightPageInfo (entity)hashtag

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

organizationCreate

Creates a new organization.

Arguments

Name
Type
Description

input

OrganizationCreateInput!

The input fields for creating the organization.

Input types:

chevron-rightOrganizationCreateInputhashtag

Input for creating a new organization.

Field
Type
Description

parentId

ID

The parent organization ID. Null for root organizations.

title

String!

The display name.

externalId

String

An external system identifier.

features

The feature flags to enable.

Output types:

chevron-rightOrganizationPayloadhashtag

The result of an organization mutation.

Field
Type
Description

organization

The created or updated organization.

chevron-rightOrganization (entity)hashtag

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

The feature flags enabled for this organization.

parent

The parent organization in the hierarchy. Null for root organizations.

children

The child organizations.

members

The members of this organization.

devices

The devices owned by this organization.

assets

The assets owned by this organization.

geoObjects

The geographic objects owned by this organization.

schedules

The schedules owned by this organization.


organizationUpdate

Updates an existing organization.

Arguments

Name
Type
Description

input

OrganizationUpdateInput!

The input fields for updating the organization.

Input types:

chevron-rightOrganizationUpdateInputhashtag

Input for updating an existing organization.

Field
Type
Description

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.

features

The new feature flags.

Output types:

chevron-rightOrganizationPayloadhashtag

The result of an organization mutation.

Field
Type
Description

organization

The created or updated organization.

chevron-rightOrganization (entity)hashtag

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

The feature flags enabled for this organization.

parent

The parent organization in the hierarchy. Null for root organizations.

children

The child organizations.

members

The members of this organization.

devices

The devices owned by this organization.

assets

The assets owned by this organization.

geoObjects

The geographic objects owned by this organization.

schedules

The schedules owned by this organization.


organizationDelete

Deletes an organization and all its data.

Arguments

Name
Type
Description

input

OrganizationDeleteInput!

The input fields for deleting the organization.

Input types:

chevron-rightOrganizationDeleteInputhashtag

Input for deleting an organization and all its data.

Field
Type
Description

id

ID!

The organization ID to delete.

version

Int!

The current version for optimistic locking.

Output types:

chevron-rightDeletePayloadhashtag

The result of a delete mutation.

Field
Type
Description

deletedId

ID!

The ID of the deleted entity.


Objects

Organization

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

The feature flags enabled for this organization.

parent

The parent organization in the hierarchy. Null for root organizations.

children

The child organizations.

members

The members of this organization.

devices

The devices owned by this organization.

assets

The assets owned by this organization.

geoObjects

The geographic objects owned by this organization.

schedules

The schedules owned by this organization.


OrganizationPayload

The result of an organization mutation.

Field
Type
Description

organization

The created or updated organization.


Inputs

OrganizationFilter

Filtering options for organizations.

Field
Type
Description

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.

Field
Type
Description

isActive

Boolean

Filter by active status.

titleContains

String

Partial match on title (case-insensitive contains).


OrganizationOrder

Ordering options for organizations.

Field
Type
Description

field

The field to order by.

direction

The direction to order.


OrganizationCreateInput

Input for creating a new organization.

Field
Type
Description

parentId

ID

The parent organization ID. Null for root organizations.

title

String!

The display name.

externalId

String

An external system identifier.

features

The feature flags to enable.


OrganizationUpdateInput

Input for updating an existing organization.

Field
Type
Description

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.

features

The new feature flags.


OrganizationDeleteInput

Input for deleting an organization and all its data.

Field
Type
Description

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.

Value
Description

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.

Value
Description

TITLE

Order by title.


Pagination types

OrganizationConnection

A paginated list of Organization items.

Implements: Connection

Field
Type
Description

edges

A list of edges.

nodes

A list of nodes in the connection (without edge metadata).

pageInfo

Information about the current page.

total

The total count of items matching the filter.


OrganizationEdge

An edge in the Organization connection.

Implements: Edge

Field
Type
Description

cursor

String!

An opaque cursor for this edge.

node

The organization at the end of the edge.


Last updated

Was this helpful?