> 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-graphql-api/products/business-data-repository/api-reference/workspaces.md).
# 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.
```graphql
workspace: Workspace!
```
**Output types:**
Workspace
A workspace that owns entities and users.
**Implements:** [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](/docs/navixy-graphql-api/core-api-reference/common.md#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` | [MemberConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces/members.md#memberconnection)! | The members of this workspace. |
| `devices` | [DeviceConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices.md#deviceconnection)! | The devices owned by this workspace. |
| `assets` | [AssetConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#assetconnection)! | The assets owned by this workspace. |
| `geoObjects` | [GeoObjectConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/geo-objects.md#geoobjectconnection)! | The geographic objects owned by this workspace. |
| `schedules` | [ScheduleConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/schedules.md#scheduleconnection)! | The schedules owned by this workspace. |
***
## Objects
### Workspace
A workspace that owns entities and users.
**Implements:** [Node](/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](/docs/navixy-graphql-api/core-api-reference/common.md#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` | [MemberConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces/members.md#memberconnection)! | The members of this workspace. |
| `devices` | [DeviceConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices.md#deviceconnection)! | The devices owned by this workspace. |
| `assets` | [AssetConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#assetconnection)! | The assets owned by this workspace. |
| `geoObjects` | [GeoObjectConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/geo-objects.md#geoobjectconnection)! | The geographic objects owned by this workspace. |
| `schedules` | [ScheduleConnection](/docs/navixy-graphql-api/products/business-data-repository/api-reference/schedules.md#scheduleconnection)! | The schedules owned by this workspace. |
**Arguments of `members`**
| Name | Type | Description |
| --------- | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `filter` | [MemberFilter](/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces/members.md#memberfilter) | Filtering options for the returned members. |
| `first` | `Int` | The first `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `after` | `String` | The elements that come after the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `last` | `Int` | The last `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `before` | `String` | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | [MemberOrder](/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces/members.md#memberorder) | The ordering options for the returned members. Default: `{ field: ASSIGNED_AT, direction: DESC }`. |
**Arguments of `devices`**
| Name | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `filter` | [DeviceFilter](/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices.md#devicefilter) | Filtering options for the returned devices. |
| `first` | `Int` | The first `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `after` | `String` | The elements that come after the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `last` | `Int` | The last `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `before` | `String` | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | [DeviceOrder](/docs/navixy-graphql-api/products/business-data-repository/api-reference/devices.md#deviceorder) | The ordering options for the returned devices. Default: `{ field: TITLE, direction: ASC }`. |
**Arguments of `assets`**
| Name | Type | Description |
| --------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `filter` | [AssetFilter](/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#assetfilter) | Filtering options for the returned assets. |
| `first` | `Int` | The first `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `after` | `String` | The elements that come after the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `last` | `Int` | The last `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `before` | `String` | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | [AssetOrder](/docs/navixy-graphql-api/products/business-data-repository/api-reference/assets.md#assetorder) | The ordering options for the returned assets. Default: `{ field: TITLE, direction: ASC }`. |
**Arguments of `geoObjects`**
| Name | Type | Description |
| --------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `filter` | [GeoObjectFilter](/docs/navixy-graphql-api/products/business-data-repository/api-reference/geo-objects.md#geoobjectfilter) | Filtering options for the returned geo objects. |
| `first` | `Int` | The first `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `after` | `String` | The elements that come after the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `last` | `Int` | The last `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `before` | `String` | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | [GeoObjectOrder](/docs/navixy-graphql-api/products/business-data-repository/api-reference/geo-objects.md#geoobjectorder) | The ordering options for the returned geo objects. Default: `{ field: TITLE, direction: ASC }`. |
**Arguments of `schedules`**
| Name | Type | Description |
| --------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `filter` | [ScheduleFilter](/docs/navixy-graphql-api/products/business-data-repository/api-reference/schedules.md#schedulefilter) | Filtering options for the returned schedules. |
| `first` | `Int` | The first `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `after` | `String` | The elements that come after the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `last` | `Int` | The last `n` elements from the [paginated list](/docs/navixy-graphql-api/pagination.md). |
| `before` | `String` | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | [ScheduleOrder](/docs/navixy-graphql-api/products/business-data-repository/api-reference/schedules.md#scheduleorder) | The ordering options for the returned schedules. Default: `{ field: TITLE, direction: ASC }`. |
***
## See also
* [Pagination](/docs/navixy-graphql-api/pagination.md)
* [Filtering and sorting](/docs/navixy-graphql-api/filtering-and-sorting.md)
* [Error handling](/docs/navixy-graphql-api/error-handling.md)
* [Optimistic locking](/docs/navixy-graphql-api/optimistic-locking.md)
* [Limits](/docs/navixy-graphql-api/limits.md)
---
# 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 by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.