> 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/organizations.md).

# Organizations

Reference for the organizations a caller can reach through Navixy Console: the accessibleOrganizations query and the ConsoleOrganization type with its connection.

The organizations the caller can access, as Navixy Console reports them, with the caller's own roles in each.

## Queries

### accessibleOrganizations

Organizations the caller can access.

```graphql
accessibleOrganizations(
    first: Int
    after: String
    last: Int
    before: String
  ): ConsoleOrganizationConnection!
```

**Arguments**

| Name     | Type     | Description                                                                                                                                             |
| -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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>ConsoleOrganizationConnection</summary>

A page of organizations the caller can access.

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

| Field      | Type                                                                         | Description                                   |
| ---------- | ---------------------------------------------------------------------------- | --------------------------------------------- |
| `edges`    | \[[ConsoleOrganizationEdge](#consoleorganizationedge)!]!                     |                                               |
| `nodes`    | \[[ConsoleOrganization](#consoleorganization)!]!                             |                                               |
| `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. |

</details>

***

## Objects

### ConsoleOrganization

An organization the caller can access, as Console reports it.

`node(id:)` and `nodes(ids:)` resolve an organization id only among the caller's own organizations, the ones `console.accessibleOrganizations` lists. Any other organization id resolves to null, and so does every organization id when the token does not carry the organization and workspace a call to Console needs, or Console refuses the caller. An organization ID issued by another Navixy deployment or region is refused with `VALIDATION_ERROR`. When Console cannot answer (not configured on the deployment, unreachable or failing), the organization resolves to null and an error with `extensions.code` SERVICE\_UNAVAILABLE and `extensions.dependency` `console` names its path; the other ids of the same `nodes(ids:)` call resolve as usual.

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

| Field         | Type         | Description                                                                                                                                                                                                                                        |
| ------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`          | `ID!`        | The organization ID, as Console issued it: the same value as `Workspace.organizationId` in Business Data Repository and `IamRole.organizationId`. `node(id:)` returns the organization for this ID when it's one of your own organizations.        |
| `slug`        | `String!`    | Console's URL-safe slug for the organization.                                                                                                                                                                                                      |
| `displayName` | `String!`    | Human-readable organization name.                                                                                                                                                                                                                  |
| `orgType`     | `String!`    | Console's own organization-type vocabulary (e.g. "customer", "partner").                                                                                                                                                                           |
| `roles`       | `[String!]!` | Console's membership preset for the caller in this organization, such as `owner` or `member`. It isn't the caller's IAM roles. Read those with [memberRoles](/docs/navixy-graphql-api/products/iam/api-reference/role-assignments.md#memberroles). |

***

## Pagination types

### ConsoleOrganizationConnection

A page of organizations the caller can access.

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

| Field      | Type                                                                         | Description                                   |
| ---------- | ---------------------------------------------------------------------------- | --------------------------------------------- |
| `edges`    | \[[ConsoleOrganizationEdge](#consoleorganizationedge)!]!                     |                                               |
| `nodes`    | \[[ConsoleOrganization](#consoleorganization)!]!                             |                                               |
| `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. |

***

### ConsoleOrganizationEdge

An edge in a ConsoleOrganizationConnection.

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

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

***

## 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/organizations.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.
