For the complete documentation index, see llms.txt. This page is also available as Markdown.
ReferenceBeta

Workspaces

Workspaces are isolated tenants that own all business data: members, devices, assets, geo objects, and configuration. The API acts in the workspace that your token names and exposes it read-only. Navi

A workspace is an isolated tenant that owns all business data: its own members, devices, assets, geo objects, and configuration. Every request acts in the workspace that the caller's token names, and the workspace query returns it. Navixy Console creates workspaces, so they are read-only in Navixy GraphQL API.

Queries

workspace (query)

The caller's workspace — the one their token names.

workspace: Workspace!

Output types:

Workspace

A workspace 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. 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.

organizationId

ID!

The Console-owned organization this workspace belongs to, by the same id as AccessibleOrganization.id. One organization may own many workspaces.

externalId

String

An external system identifier for integration purposes.

isActive

Boolean!

Whether this workspace is active.

members

The members of this workspace.

devices

The devices owned by this workspace.

assets

The assets owned by this workspace.

geoObjects

The geographic objects owned by this workspace.

schedules

The schedules owned by this workspace.


Objects

Workspace

A workspace 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. 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.

organizationId

ID!

The Console-owned organization this workspace belongs to, by the same id as AccessibleOrganization.id. One organization may own many workspaces.

externalId

String

An external system identifier for integration purposes.

isActive

Boolean!

Whether this workspace is active.

members

The members of this workspace.

devices

The devices owned by this workspace.

assets

The assets owned by this workspace.

geoObjects

The geographic objects owned by this workspace.

schedules

The schedules owned by this workspace.

Arguments of members

Name
Type
Description

filter

Filtering options for the returned members.

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

The ordering options for the returned members. Default: { field: ASSIGNED_AT, direction: DESC }.

Arguments of devices

Name
Type
Description

filter

Filtering options for the returned devices.

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

The ordering options for the returned devices. Default: { field: TITLE, direction: ASC }.

Arguments of assets

Name
Type
Description

filter

Filtering options for the returned assets.

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

The ordering options for the returned assets. Default: { field: TITLE, direction: ASC }.

Arguments of geoObjects

Name
Type
Description

filter

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

The ordering options for the returned geo objects. Default: { field: TITLE, direction: ASC }.

Arguments of schedules

Name
Type
Description

filter

Filtering options for the returned schedules.

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

The ordering options for the returned schedules. Default: { field: TITLE, direction: ASC }.


See also

Last updated

Was this helpful?