> 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/business-data-repository/api-reference/workspaces/members.md).

# Members

Query reference for workspace members: which users belong to a workspace, whether each membership is active, and when it was assigned.

{% hint style="warning" %}
**Navixy GraphQL API is a work in progress.** This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.
{% endhint %}

Workspace members represent the relationship between users and workspaces: which user belongs to which workspace, whether the membership is active, and when it was assigned.

## Queries

### member (query)

Retrieves a member by its ID.

```graphql
member(id: ID!): Member
```

**Arguments**

| Name | Type  | Description                       |
| ---- | ----- | --------------------------------- |
| `id` | `ID!` | The ID of the member to retrieve. |

**Output types:**

<details>

<summary>Member</summary>

A user's membership in a workspace.

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

| 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. |
| `user`       | [User](/docs/navixy-graphql-api/business-data-repository/api-reference/actors/users.md#user)!         | The user.                                                                                                                                                                                                 |
| `workspace`  | [Workspace](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace)! | The workspace the user belongs to.                                                                                                                                                                        |
| `isActive`   | `Boolean!`                                                                                            | Whether this membership is active.                                                                                                                                                                        |
| `assignedAt` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                           | The date and time when the user was assigned to this workspace.                                                                                                                                           |

</details>

***

### members

Lists members of a workspace.

```graphql
members(
    workspaceId: ID!
    filter: MemberFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: MemberOrder = { field: ASSIGNED_AT, direction: DESC }
  ): MemberConnection!
```

**Arguments**

| Name          | Type           | Description                                                                                   |
| ------------- | -------------- | --------------------------------------------------------------------------------------------- |
| `workspaceId` | `ID!`          | The workspace to retrieve members for.                                                        |
| `filter`      | `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`  | The ordering options for the returned members.                                                |

**Input types:**

<details>

<summary>MemberFilter</summary>

Filtering options for members.

| Field      | Type      | Description                        |
| ---------- | --------- | ---------------------------------- |
| `userIds`  | `[ID!]`   | Filter by users (OR within field). |
| `isActive` | `Boolean` | Filter by active status.           |

</details>

<details>

<summary>MemberOrder</summary>

Ordering options for members.

| Field       | Type                                                                                    | Description             |
| ----------- | --------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [MemberOrderField](#memberorderfield)!                                                  | The field to order by.  |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |

</details>

**Output types:**

<details>

<summary>MemberConnection</summary>

A paginated list of Member items.

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

| Field      | Type                                                                         | Description                                                |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[MemberEdge](#memberedge)!]!                                               | A list of edges.                                           |
| `nodes`    | \[[Member](#member)!]!                                                       | A list of nodes in the connection (without edge metadata). |
| `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>

***

## Mutations

### memberCreate

Adds a user to a workspace as a member.

```graphql
memberCreate(
    input: MemberCreateInput!
  ): MemberPayload
```

**Arguments**

| Name    | Type                 | Description                                   |
| ------- | -------------------- | --------------------------------------------- |
| `input` | `MemberCreateInput!` | The input fields for creating the membership. |

**Input types:**

<details>

<summary>MemberCreateInput</summary>

Input for creating a membership.

| Field         | Type  | Description         |
| ------------- | ----- | ------------------- |
| `workspaceId` | `ID!` | The workspace ID.   |
| `userId`      | `ID!` | The user ID to add. |

</details>

**Output types:**

<details>

<summary>MemberPayload</summary>

The result of a membership mutation.

| Field    | Type               | Description                        |
| -------- | ------------------ | ---------------------------------- |
| `member` | [Member](#member)! | The created or updated membership. |

</details>

<details>

<summary>Member (entity)</summary>

A user's membership in a workspace.

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

| 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. |
| `user`       | [User](/docs/navixy-graphql-api/business-data-repository/api-reference/actors/users.md#user)!         | The user.                                                                                                                                                                                                 |
| `workspace`  | [Workspace](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace)! | The workspace the user belongs to.                                                                                                                                                                        |
| `isActive`   | `Boolean!`                                                                                            | Whether this membership is active.                                                                                                                                                                        |
| `assignedAt` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                           | The date and time when the user was assigned to this workspace.                                                                                                                                           |

</details>

***

### memberUpdate

Updates a membership.

```graphql
memberUpdate(
    input: MemberUpdateInput!
  ): MemberPayload
```

**Arguments**

| Name    | Type                 | Description                                   |
| ------- | -------------------- | --------------------------------------------- |
| `input` | `MemberUpdateInput!` | The input fields for updating the membership. |

**Input types:**

<details>

<summary>MemberUpdateInput</summary>

Input for updating a membership.

| Field      | Type      | Description                                                                                     |
| ---------- | --------- | ----------------------------------------------------------------------------------------------- |
| `id`       | `ID!`     | The membership ID to update.                                                                    |
| `version`  | `Int`     | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `isActive` | `Boolean` | The new active status.                                                                          |

</details>

**Output types:**

<details>

<summary>MemberPayload</summary>

The result of a membership mutation.

| Field    | Type               | Description                        |
| -------- | ------------------ | ---------------------------------- |
| `member` | [Member](#member)! | The created or updated membership. |

</details>

<details>

<summary>Member (entity)</summary>

A user's membership in a workspace.

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

| 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. |
| `user`       | [User](/docs/navixy-graphql-api/business-data-repository/api-reference/actors/users.md#user)!         | The user.                                                                                                                                                                                                 |
| `workspace`  | [Workspace](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace)! | The workspace the user belongs to.                                                                                                                                                                        |
| `isActive`   | `Boolean!`                                                                                            | Whether this membership is active.                                                                                                                                                                        |
| `assignedAt` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                           | The date and time when the user was assigned to this workspace.                                                                                                                                           |

</details>

***

### memberRemove

Removes a user from a workspace.

```graphql
memberRemove(
    input: MemberRemoveInput!
  ): DeletePayload
```

**Arguments**

| Name    | Type                 | Description                                   |
| ------- | -------------------- | --------------------------------------------- |
| `input` | `MemberRemoveInput!` | The input fields for removing the membership. |

**Input types:**

<details>

<summary>MemberRemoveInput</summary>

Input for removing a membership.

| Field     | Type  | Description                                                                                     |
| --------- | ----- | ----------------------------------------------------------------------------------------------- |
| `id`      | `ID!` | The membership ID to remove.                                                                    |
| `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

### Member

A user's membership in a workspace.

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

| 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. |
| `user`       | [User](/docs/navixy-graphql-api/business-data-repository/api-reference/actors/users.md#user)!         | The user.                                                                                                                                                                                                 |
| `workspace`  | [Workspace](/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces.md#workspace)! | The workspace the user belongs to.                                                                                                                                                                        |
| `isActive`   | `Boolean!`                                                                                            | Whether this membership is active.                                                                                                                                                                        |
| `assignedAt` | [DateTime](/docs/navixy-graphql-api/core-api-reference/common.md#datetime)!                           | The date and time when the user was assigned to this workspace.                                                                                                                                           |

***

### MemberPayload

The result of a membership mutation.

| Field    | Type               | Description                        |
| -------- | ------------------ | ---------------------------------- |
| `member` | [Member](#member)! | The created or updated membership. |

***

## Inputs

### MemberFilter

Filtering options for members.

| Field      | Type      | Description                        |
| ---------- | --------- | ---------------------------------- |
| `userIds`  | `[ID!]`   | Filter by users (OR within field). |
| `isActive` | `Boolean` | Filter by active status.           |

***

### MemberOrder

Ordering options for members.

| Field       | Type                                                                                    | Description             |
| ----------- | --------------------------------------------------------------------------------------- | ----------------------- |
| `field`     | [MemberOrderField](#memberorderfield)!                                                  | The field to order by.  |
| `direction` | [OrderDirection](/docs/navixy-graphql-api/core-api-reference/common.md#orderdirection)! | The direction to order. |

***

### MemberCreateInput

Input for creating a membership.

| Field         | Type  | Description         |
| ------------- | ----- | ------------------- |
| `workspaceId` | `ID!` | The workspace ID.   |
| `userId`      | `ID!` | The user ID to add. |

***

### MemberUpdateInput

Input for updating a membership.

| Field      | Type      | Description                                                                                     |
| ---------- | --------- | ----------------------------------------------------------------------------------------------- |
| `id`       | `ID!`     | The membership ID to update.                                                                    |
| `version`  | `Int`     | The current version for optimistic locking. If omitted, auto-increments without conflict check. |
| `isActive` | `Boolean` | The new active status.                                                                          |

***

### MemberRemoveInput

Input for removing a membership.

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

***

## Enums

### MemberOrderField

Fields available for ordering members.

| Value         | Description               |
| ------------- | ------------------------- |
| `ASSIGNED_AT` | Order by assignment date. |

***

## Pagination types

### MemberConnection

A paginated list of Member items.

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

| Field      | Type                                                                         | Description                                                |
| ---------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `edges`    | \[[MemberEdge](#memberedge)!]!                                               | A list of edges.                                           |
| `nodes`    | \[[Member](#member)!]!                                                       | A list of nodes in the connection (without edge metadata). |
| `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.              |

***

### MemberEdge

An edge in the Member connection.

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

| Field    | Type               | Description                        |
| -------- | ------------------ | ---------------------------------- |
| `cursor` | `String!`          | An opaque cursor for this edge.    |
| `node`   | [Member](#member)! | The member at the end of the edge. |

***

## 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-graphql-api/business-data-repository/api-reference/workspaces/members.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.