> 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/console/api-reference/workspaces.md).

# Workspaces

Reference for the workspaces a caller can reach through Navixy Console: the accessibleWorkspaces query and the ConsoleWorkspace type with its connection.

The workspaces the caller can access, as Navixy Console reports them, with the organization and the zone each one belongs to.

## Queries

### accessibleWorkspaces

Workspaces the caller can access, optionally narrowed to one organization.

```graphql
accessibleWorkspaces(
    organizationId: ID
    first: Int
    after: String
    last: Int
    before: String
  ): ConsoleWorkspaceConnection!
```

**Arguments**

| Name             | Type     | Description                                                                                                                                                                                                               |
| ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organizationId` | `ID`     | Only the workspaces of this organization. Leave it out to list the workspaces of every organization you belong to. A value that isn't an organization ID returns `VALIDATION_ERROR` with `field` set to `organizationId`. |
| `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). Requires `before` — Console pages backward only from a cursor.                                                                   |
| `before`         | `String` | The elements that come before the specified [cursor](/docs/navixy-graphql-api/pagination.md). Requires `last`.                                                                                                            |

**Output types:**

<details>

<summary>ConsoleWorkspaceConnection</summary>

A page of workspaces the caller can access.

**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                         | Description                                                                                                                                                                                                                                                                           |
| ---------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `edges`    | \[[ConsoleWorkspaceEdge](#consoleworkspaceedge)!]!                           |                                                                                                                                                                                                                                                                                       |
| `nodes`    | \[[ConsoleWorkspace](#consoleworkspace)!]!                                   |                                                                                                                                                                                                                                                                                       |
| `pageInfo` | [PageInfo](/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                                                                                                                                                                                                                                                   |
| `total`    | [CountInfo](/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter, with precision APPROXIMATE: Console counts every workspace, including any whose ID isn't a workspace ID of this deployment and which this query leaves out of `edges` and `nodes`, so the count can exceed what the connection returns. |

</details>

***

## Objects

### ConsoleWorkspace

A workspace the caller can access, as Console reports it.

| Field                     | Type      | Description                                                                                                                                                                                                                                   |
| ------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                      | `ID!`     | The workspace ID, as Console issued it: the same value as `Workspace.id` in Business Data Repository. `node(id:)` returns the Business Data Repository `Workspace` for the workspace that your token names, and `null` for another workspace. |
| `workspaceName`           | `String!` | Human-readable workspace name.                                                                                                                                                                                                                |
| `organizationId`          | `ID!`     | The ID of the organization this workspace belongs to: the same value as `ConsoleOrganization.id`.                                                                                                                                             |
| `organizationDisplayName` | `String!` | Human-readable name of the organization this workspace belongs to.                                                                                                                                                                            |
| `status`                  | `String!` | Console's own workspace-status vocabulary (e.g. "active", "suspended").                                                                                                                                                                       |
| `zoneDisplayName`         | `String!` | Human-readable name of the zone (region/cluster) this workspace is hosted in.                                                                                                                                                                 |
| `zoneRegion`              | `String`  | Console's own region code for the zone this workspace is hosted in. Null when the zone has none.                                                                                                                                              |

***

## Pagination types

### ConsoleWorkspaceConnection

A page of workspaces the caller can access.

**Implements:** [Connection](/docs/navixy-graphql-api/core-api-reference/common.md#connection)

| Field      | Type                                                                         | Description                                                                                                                                                                                                                                                                           |
| ---------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `edges`    | \[[ConsoleWorkspaceEdge](#consoleworkspaceedge)!]!                           |                                                                                                                                                                                                                                                                                       |
| `nodes`    | \[[ConsoleWorkspace](#consoleworkspace)!]!                                   |                                                                                                                                                                                                                                                                                       |
| `pageInfo` | [PageInfo](/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                                                                                                                                                                                                                                                   |
| `total`    | [CountInfo](/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter, with precision APPROXIMATE: Console counts every workspace, including any whose ID isn't a workspace ID of this deployment and which this query leaves out of `edges` and `nodes`, so the count can exceed what the connection returns. |

***

### ConsoleWorkspaceEdge

An edge in a ConsoleWorkspaceConnection.

**Implements:** [Edge](/docs/navixy-graphql-api/core-api-reference/common.md#edge)

| Field    | Type                                   | Description                     |
| -------- | -------------------------------------- | ------------------------------- |
| `cursor` | `String!`                              | An opaque cursor for this edge. |
| `node`   | [ConsoleWorkspace](#consoleworkspace)! |                                 |

***

## See also

* [Pagination](/docs/navixy-graphql-api/pagination.md)
* [Error handling](/docs/navixy-graphql-api/error-handling.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/console/api-reference/workspaces.md?ask=<question>&goal=<user_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.