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

# Users

Reference for the me query, with the caller's organizations, workspaces, products, and roles, and for user-defined catalog items and their mutations.

The `me` query, which describes the caller, and the catalog items that users define in their workspace.

## Queries

### me (query)

The caller, with the organizations and workspaces they can switch to.

```graphql
me: Me!
```

**Output types:**

<details>

<summary>Me</summary>

The caller of the request, and the organizations and workspaces that the caller can switch to.

| Field           | Type                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| --------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`            | `ID!`                                                 | The ID of the caller. Other operations of the API use the same ID for the caller.                                                                                                                                                                                                                                                                                                                                                                                        |
| `title`         | `String!`                                             | The caller's display name, taken from the access token: the full name, or the email address when the token has no name. The API doesn't store it.                                                                                                                                                                                                                                                                                                                        |
| `organizations` | \[[AccessibleOrganization](#accessibleorganization)!] | Every organization in which the caller is an active member in Navixy Console, with its workspaces except terminated ones. Each organization lists only the workspaces that the caller's roles reach. `null`, with an error at this path, when the list cannot be read: `PERMISSION_DENIED` when the access token names no caller, `NOT_FOUND` when Navixy Console has no active user with the caller's ID, and `SERVICE_UNAVAILABLE` when Navixy Console doesn't answer. |
| `products`      | \[[MeProduct](#meproduct)!]                           | The products that the caller may use in the workspace of the access token: the products of the token that a role of the caller covers. The list includes products whose `isActive` is `false`. Empty when the token's workspace isn't found or the caller has no role in it. `null`, with a `SERVICE_UNAVAILABLE` error at this path, when the product list can't be read.                                                                                               |
| `roles`         | \[[MeRole](#merole)!]                                 | The caller's roles in the workspace of the access token: the active roles of the token's organization that reach this workspace. The API checks every permission against these roles. Empty when the token's workspace isn't found or the caller has no role in it.                                                                                                                                                                                                      |

</details>

***

## Mutations

### userCatalogItemCreate

Creates a new user catalog item.

```graphql
userCatalogItemCreate(
    input: UserCatalogItemCreateInput!
  ): UserCatalogItemPayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                          | Description                             |
| ------- | ----------------------------- | --------------------------------------- |
| `input` | `UserCatalogItemCreateInput!` | The input fields for creating the item. |

**Input types:**

<details>

<summary>UserCatalogItemCreateInput</summary>

Input for creating a user catalog item.

| Field       | Type                                                                                                                                                              | Description                                                                                               |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `catalogId` | `ID!`                                                                                                                                                             | The catalog to add the item to.                                                                           |
| `code`      | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)                                                                              | The machine-readable code, unique within the catalog and workspace. Auto-generated from title if omitted. |
| `title`     | `String!`                                                                                                                                                         | The display name.                                                                                         |
| `order`     | `Int`                                                                                                                                                             | The display order. Auto-calculated as last position if omitted.                                           |
| `parentId`  | `ID`                                                                                                                                                              | The parent item ID for hierarchical catalogs.                                                             |
| `meta`      | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                                                                   |

</details>

<details>

<summary>CatalogItemMetaInput</summary>

Display properties for catalog items.

| Field         | Type      | Description                                       |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String`  | The description.                                  |
| `hidden`      | `Boolean` | Whether the item is hidden from regular UI lists. |

</details>

**Output types:**

<details>

<summary>UserCatalogItemPayload</summary>

The result of a user catalog item mutation.

| Field  | Type                                 | Description                               |
| ------ | ------------------------------------ | ----------------------------------------- |
| `item` | [UserCatalogItem](#usercatalogitem)! | The created or updated user catalog item. |

</details>

<details>

<summary>UserCatalogItem (entity)</summary>

A user-defined catalog item that supports hierarchical workspace.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [HierarchicalCatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#hierarchicalcatalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled)

| Field       | Type                                                                                                                                                     | Description                                                                                                                                    |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`        | `ID!`                                                                                                                                                    | A globally unique identifier.                                                                                                                  |
| `version`   | `Int!`                                                                                                                                                   | The version number for optimistic locking.                                                                                                     |
| `title`     | `String!`                                                                                                                                                | The human-readable display name. Can be localized.                                                                                             |
| `code`      | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |
| `parent`    | [UserCatalogItem](#usercatalogitem)                                                                                                                      | The parent item in the hierarchy. Null for root items.                                                                                         |
| `children`  | [UserCatalogItemConnection](#usercatalogitemconnection)!                                                                                                 | The child items in the hierarchy.                                                                                                              |

</details>

***

### userCatalogItemUpdate

Updates a user catalog item.

```graphql
userCatalogItemUpdate(
    input: UserCatalogItemUpdateInput!
  ): UserCatalogItemPayload @effect(kinds: [NONE])
```

**Arguments**

| Name    | Type                          | Description                             |
| ------- | ----------------------------- | --------------------------------------- |
| `input` | `UserCatalogItemUpdateInput!` | The input fields for updating the item. |

**Input types:**

<details>

<summary>UserCatalogItemUpdateInput</summary>

Input for updating a user catalog item.

| Field      | Type                                                                                                                                                              | Description                                                                                     |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id`       | `ID!`                                                                                                                                                             | The item ID to update.                                                                          |
| `version`  | `Int`                                                                                                                                                             | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title`    | `String`                                                                                                                                                          | The new display name.                                                                           |
| `order`    | `Int`                                                                                                                                                             | The new display order.                                                                          |
| `parentId` | `ID`                                                                                                                                                              | The new parent ID for hierarchical items.                                                       |
| `meta`     | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                                                         |

</details>

<details>

<summary>CatalogItemMetaInput</summary>

Display properties for catalog items.

| Field         | Type      | Description                                       |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String`  | The description.                                  |
| `hidden`      | `Boolean` | Whether the item is hidden from regular UI lists. |

</details>

**Output types:**

<details>

<summary>UserCatalogItemPayload</summary>

The result of a user catalog item mutation.

| Field  | Type                                 | Description                               |
| ------ | ------------------------------------ | ----------------------------------------- |
| `item` | [UserCatalogItem](#usercatalogitem)! | The created or updated user catalog item. |

</details>

<details>

<summary>UserCatalogItem (entity)</summary>

A user-defined catalog item that supports hierarchical workspace.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [HierarchicalCatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#hierarchicalcatalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled)

| Field       | Type                                                                                                                                                     | Description                                                                                                                                    |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`        | `ID!`                                                                                                                                                    | A globally unique identifier.                                                                                                                  |
| `version`   | `Int!`                                                                                                                                                   | The version number for optimistic locking.                                                                                                     |
| `title`     | `String!`                                                                                                                                                | The human-readable display name. Can be localized.                                                                                             |
| `code`      | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |
| `parent`    | [UserCatalogItem](#usercatalogitem)                                                                                                                      | The parent item in the hierarchy. Null for root items.                                                                                         |
| `children`  | [UserCatalogItemConnection](#usercatalogitemconnection)!                                                                                                 | The child items in the hierarchy.                                                                                                              |

</details>

***

### userCatalogItemDelete

Deletes a user catalog item.

Refused with `IN_USE` while another live entity points at it through one of its own fields, custom-field values and field definitions included; the error's `blockers` name the first five of them, and `hasMoreBlockers` says whether it left any out.

```graphql
userCatalogItemDelete(
    input: CatalogItemDeleteInput!
  ): DeletePayload @effect(kinds: [DATA_LOSS])
```

**Arguments**

| Name    | Type                      | Description                             |
| ------- | ------------------------- | --------------------------------------- |
| `input` | `CatalogItemDeleteInput!` | The input fields for deleting the item. |

**Input types:**

<details>

<summary>CatalogItemDeleteInput</summary>

Input for deleting a catalog item.

| Field     | Type  | Description                                                                                     |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id`      | `ID!` | The catalog item ID to delete.                                                                  |
| `version` | `Int` | The current version for optimistic locking. If omitted, auto-increments without conflict check. |

</details>

**Output types:**

<details>

<summary>DeletePayload</summary>

The result of a delete mutation.

| Field       | Type  | Description                   |
| ----------- | ----- | ----------------------------- |
| `deletedId` | `ID!` | The ID of the deleted entity. |

</details>

***

## Objects

### UserCatalogItem

A user-defined catalog item that supports hierarchical workspace.

**Implements:** [CatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitem), [HierarchicalCatalogItem](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#hierarchicalcatalogitem), [Node](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#node), [Versioned](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#versioned), [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled)

| Field       | Type                                                                                                                                                     | Description                                                                                                                                    |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`        | `ID!`                                                                                                                                                    | A globally unique identifier.                                                                                                                  |
| `version`   | `Int!`                                                                                                                                                   | The version number for optimistic locking.                                                                                                     |
| `title`     | `String!`                                                                                                                                                | The human-readable display name. Can be localized.                                                                                             |
| `code`      | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)!                                                                    | A machine-readable code, unique within the catalog for a given workspace. A workspace item may reuse the code of the system item it overrides. |
| `order`     | `Int!`                                                                                                                                                   | The display order within the same level or category.                                                                                           |
| `catalog`   | [Catalog](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalog)!                 | The catalog this item belongs to.                                                                                                              |
| `workspace` | [Workspace](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/workspaces.md#workspace)                          | The workspace that owns this item. Null for system items.                                                                                      |
| `meta`      | [CatalogItemMeta](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmeta)! | Metadata about this item including description, origin, and display properties.                                                                |
| `parent`    | [UserCatalogItem](#usercatalogitem)                                                                                                                      | The parent item in the hierarchy. Null for root items.                                                                                         |
| `children`  | [UserCatalogItemConnection](#usercatalogitemconnection)!                                                                                                 | The child items in the hierarchy.                                                                                                              |

**Arguments of `children`**

| Name      | Type                                                                                                                                                                        | Description                                                                                                     |
| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `filter`  | [CatalogItemChildrenFilter](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemchildrenfilter) | Filtering options for the returned children.                                                                    |
| `first`   | `Int`                                                                                                                                                                       | The first `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).     |
| `after`   | `String`                                                                                                                                                                    | The elements that come after the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md).  |
| `last`    | `Int`                                                                                                                                                                       | The last `n` elements from the [paginated list](https://navixy.com/docs/navixy-graphql-api/pagination.md).      |
| `before`  | `String`                                                                                                                                                                    | The elements that come before the specified [cursor](https://navixy.com/docs/navixy-graphql-api/pagination.md). |
| `orderBy` | [CatalogItemOrder](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemorder)                   | The ordering options for the returned children. Default: `{ field: ORDER, direction: ASC }`.                    |

***

### Me

The caller of the request, and the organizations and workspaces that the caller can switch to.

| Field           | Type                                                  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| --------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`            | `ID!`                                                 | The ID of the caller. Other operations of the API use the same ID for the caller.                                                                                                                                                                                                                                                                                                                                                                                        |
| `title`         | `String!`                                             | The caller's display name, taken from the access token: the full name, or the email address when the token has no name. The API doesn't store it.                                                                                                                                                                                                                                                                                                                        |
| `organizations` | \[[AccessibleOrganization](#accessibleorganization)!] | Every organization in which the caller is an active member in Navixy Console, with its workspaces except terminated ones. Each organization lists only the workspaces that the caller's roles reach. `null`, with an error at this path, when the list cannot be read: `PERMISSION_DENIED` when the access token names no caller, `NOT_FOUND` when Navixy Console has no active user with the caller's ID, and `SERVICE_UNAVAILABLE` when Navixy Console doesn't answer. |
| `products`      | \[[MeProduct](#meproduct)!]                           | The products that the caller may use in the workspace of the access token: the products of the token that a role of the caller covers. The list includes products whose `isActive` is `false`. Empty when the token's workspace isn't found or the caller has no role in it. `null`, with a `SERVICE_UNAVAILABLE` error at this path, when the product list can't be read.                                                                                               |
| `roles`         | \[[MeRole](#merole)!]                                 | The caller's roles in the workspace of the access token: the active roles of the token's organization that reach this workspace. The API checks every permission against these roles. Empty when the token's workspace isn't found or the caller has no role in it.                                                                                                                                                                                                      |

***

### MeProduct

A product that the caller may use.

**Implements:** [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled)

| Field          | Type                                                                                  | Description                                                                                                                    |
| -------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `code`         | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)! | The product code. Access tokens and roles name the product by this code.                                                       |
| `title`        | `String!`                                                                             | The name of the product, or its code when the product has no name.                                                             |
| `description`  | `String`                                                                              |                                                                                                                                |
| `url`          | `String`                                                                              | The product's user-facing address.                                                                                             |
| `internalPath` | `String`                                                                              | The product's internal address: an absolute http or https URL, or a path that starts with a single `/`. Null when none is set. |
| `isActive`     | `Boolean!`                                                                            | Whether the product is switched on.                                                                                            |

***

### MeRole

A role of the caller.

**Implements:** [Titled](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#titled)

| Field         | Type       | Description                                                                 |
| ------------- | ---------- | --------------------------------------------------------------------------- |
| `id`          | `ID!`      | The ID of the role. The access token lists the caller's roles by these IDs. |
| `title`       | `String!`  | The human-readable display name.                                            |
| `description` | `String`   |                                                                             |
| `isSystem`    | `Boolean!` | `true` for a built-in role, which no administrator can edit.                |

***

### AccessibleOrganization

An organization the caller can switch to.

| Field        | Type                                             | Description                                                             |
| ------------ | ------------------------------------------------ | ----------------------------------------------------------------------- |
| `id`         | `ID!`                                            | The ID of the organization in Navixy Console.                           |
| `title`      | `String!`                                        | The organization's display name in Console.                             |
| `workspaces` | \[[AccessibleWorkspace](#accessibleworkspace)!]! | The organization's workspaces other than terminated ones. May be empty. |

***

### AccessibleWorkspace

A workspace the caller can switch to.

| Field      | Type       | Description                                                                                                                                                                                                                                     |
| ---------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`       | `ID!`      | The ID of the workspace in Navixy Console: the workspace ID that an access token names. When the workspace has data in Business Data Repository, its `Workspace.id` is the same. Workspaces created before the current ID format aren't listed. |
| `title`    | `String!`  | The workspace's name in Console.                                                                                                                                                                                                                |
| `isActive` | `Boolean!` | Whether the workspace is ready: `true` when its status in Navixy Console is `active`. `Workspace.isActive` follows the same rule. A workspace still being created, stopped or failed is listed with `false`.                                    |

***

### UserCatalogItemPayload

The result of a user catalog item mutation.

| Field  | Type                                 | Description                               |
| ------ | ------------------------------------ | ----------------------------------------- |
| `item` | [UserCatalogItem](#usercatalogitem)! | The created or updated user catalog item. |

***

## Inputs

### UserCatalogItemCreateInput

Input for creating a user catalog item.

| Field       | Type                                                                                                                                                              | Description                                                                                               |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `catalogId` | `ID!`                                                                                                                                                             | The catalog to add the item to.                                                                           |
| `code`      | [Code](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#code)                                                                              | The machine-readable code, unique within the catalog and workspace. Auto-generated from title if omitted. |
| `title`     | `String!`                                                                                                                                                         | The display name.                                                                                         |
| `order`     | `Int`                                                                                                                                                             | The display order. Auto-calculated as last position if omitted.                                           |
| `parentId`  | `ID`                                                                                                                                                              | The parent item ID for hierarchical catalogs.                                                             |
| `meta`      | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                                                                   |

***

### UserCatalogItemUpdateInput

Input for updating a user catalog item.

| Field      | Type                                                                                                                                                              | Description                                                                                     |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `id`       | `ID!`                                                                                                                                                             | The item ID to update.                                                                          |
| `version`  | `Int`                                                                                                                                                             | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `title`    | `String`                                                                                                                                                          | The new display name.                                                                           |
| `order`    | `Int`                                                                                                                                                             | The new display order.                                                                          |
| `parentId` | `ID`                                                                                                                                                              | The new parent ID for hierarchical items.                                                       |
| `meta`     | [CatalogItemMetaInput](https://navixy.com/docs/navixy-graphql-api/products/business-data-repository/api-reference/catalogs/catalog-items.md#catalogitemmetainput) | The display properties.                                                                         |

***

## Pagination types

### UserCatalogItemConnection

A paginated list of UserCatalogItem items.

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

| Field      | Type                                                                                           | Description                                                |
| ---------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[UserCatalogItemEdge](#usercatalogitemedge)!]!                                               | A list of edges.                                           |
| `nodes`    | \[[UserCatalogItem](#usercatalogitem)!]!                                                       | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](https://navixy.com/docs/navixy-graphql-api/core-api-reference/common.md#countinfo) | The total count of items matching the filter.              |

***

### UserCatalogItemEdge

An edge in the UserCatalogItem connection.

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

| Field    | Type                                 | Description                                   |
| -------- | ------------------------------------ | --------------------------------------------- |
| `cursor` | `String!`                            | An opaque cursor for this edge.               |
| `node`   | [UserCatalogItem](#usercatalogitem)! | The user catalog item at the end of the edge. |

***

## See also

* [Pagination](https://navixy.com/docs/navixy-graphql-api/pagination.md)
* [Filtering and sorting](https://navixy.com/docs/navixy-graphql-api/filtering-and-sorting.md)
* [Error handling](https://navixy.com/docs/navixy-graphql-api/error-handling.md)
* [Optimistic locking](https://navixy.com/docs/navixy-graphql-api/optimistic-locking.md)
* [Limits](https://navixy.com/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/users.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.
