---
title: Members
url: https://platform.claude.com/docs/en/api/java/organization/workspaces/members
---

# Members

## List Workspace Members

`MemberListPage organization().workspaces().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())`

**GET** `/v1/organizations/workspaces/{workspace_id}/members`

List Workspace Members

### Parameters

- `MemberListParams params`

  - `Optional<String> workspaceId` (path parameter)

    ID of the Workspace.

  - `Optional<String> afterId` (query parameter)

    ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

  - `Optional<String> beforeId` (query parameter)

    ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

  - `Optional<Long> limit` (query parameter)

    Number of items to return per page.

    Defaults to `20`. Ranges from `1` to `1000`.

    minimum: 1, maximum: 1000

### Returns

- `class WorkspaceMember`

  - `JsonValue type = "workspace_member"`

    Object type.

    For Workspace Members, this is always `"workspace_member"`.

  - `String userId`

    ID of the User.

  - `String workspaceId`

    ID of the Workspace.

  - `WorkspaceRole workspaceRole`

    Role of the Workspace Member.

    - `WORKSPACE_ADMIN("workspace_admin")`

    - `WORKSPACE_BILLING("workspace_billing")`

    - `WORKSPACE_DEVELOPER("workspace_developer")`

    - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")`

    - `WORKSPACE_USER("workspace_user")`

### Example

```java
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.workspaces.members.MemberListPage;
import com.anthropic.models.organization.workspaces.members.MemberListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        MemberListPage page = client.organization().workspaces().members().list("workspace_id");
    }
}
```

#### Response (200)

```json
{
  "data": [
    {
      "type": "workspace_member",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
      "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
      "workspace_role": "workspace_admin"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}
```

## Create Workspace Member

`WorkspaceMember organization().workspaces().members().add(params, requestOptions = RequestOptions.none())`

**POST** `/v1/organizations/workspaces/{workspace_id}/members`

Create Workspace Member

### Parameters

- `MemberAddParams params`

  - `Optional<String> workspaceId` (path parameter)

    ID of the Workspace.

  - `String userId`

    ID of the User.

  - `NoBillingWorkspaceRole workspaceRole`

    Role of the new Workspace Member. Cannot be `workspace_billing`.

### Returns

- `class WorkspaceMember`

  - `JsonValue type = "workspace_member"`

    Object type.

    For Workspace Members, this is always `"workspace_member"`.

  - `String userId`

    ID of the User.

  - `String workspaceId`

    ID of the Workspace.

  - `WorkspaceRole workspaceRole`

    Role of the Workspace Member.

    - `WORKSPACE_ADMIN("workspace_admin")`

    - `WORKSPACE_BILLING("workspace_billing")`

    - `WORKSPACE_DEVELOPER("workspace_developer")`

    - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")`

    - `WORKSPACE_USER("workspace_user")`

### Example

```java
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.workspaces.NoBillingWorkspaceRole;
import com.anthropic.models.organization.workspaces.WorkspaceMember;
import com.anthropic.models.organization.workspaces.members.MemberAddParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        MemberAddParams params = MemberAddParams.builder()
            .workspaceId("workspace_id")
            .userId("user_01WCz1FkmYMm4gnmykNKUu3Q")
            .workspaceRole(NoBillingWorkspaceRole.WORKSPACE_ADMIN)
            .build();
        WorkspaceMember workspaceMember = client.organization().workspaces().members().add(params);
    }
}
```

#### Response (200)

```json
{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_admin"
}
```

## Get Workspace Member

`WorkspaceMember organization().workspaces().members().retrieve(params, requestOptions = RequestOptions.none())`

**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

Get Workspace Member

### Parameters

- `MemberRetrieveParams params`

  - `String workspaceId` (path parameter)

    ID of the Workspace.

  - `Optional<String> userId` (path parameter)

    ID of the User.

### Returns

- `class WorkspaceMember`

  - `JsonValue type = "workspace_member"`

    Object type.

    For Workspace Members, this is always `"workspace_member"`.

  - `String userId`

    ID of the User.

  - `String workspaceId`

    ID of the Workspace.

  - `WorkspaceRole workspaceRole`

    Role of the Workspace Member.

    - `WORKSPACE_ADMIN("workspace_admin")`

    - `WORKSPACE_BILLING("workspace_billing")`

    - `WORKSPACE_DEVELOPER("workspace_developer")`

    - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")`

    - `WORKSPACE_USER("workspace_user")`

### Example

```java
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.workspaces.WorkspaceMember;
import com.anthropic.models.organization.workspaces.members.MemberRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        MemberRetrieveParams params = MemberRetrieveParams.builder()
            .workspaceId("workspace_id")
            .userId("user_id")
            .build();
        WorkspaceMember workspaceMember = client.organization().workspaces().members().retrieve(params);
    }
}
```

#### Response (200)

```json
{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_admin"
}
```

## Update Workspace Member

`WorkspaceMember organization().workspaces().members().update(params, requestOptions = RequestOptions.none())`

**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

Update Workspace Member

### Parameters

- `MemberUpdateParams params`

  - `String workspaceId` (path parameter)

    ID of the Workspace.

  - `Optional<String> userId` (path parameter)

    ID of the User.

  - `WorkspaceRole workspaceRole`

    New workspace role for the User.

### Returns

- `class WorkspaceMember`

  - `JsonValue type = "workspace_member"`

    Object type.

    For Workspace Members, this is always `"workspace_member"`.

  - `String userId`

    ID of the User.

  - `String workspaceId`

    ID of the Workspace.

  - `WorkspaceRole workspaceRole`

    Role of the Workspace Member.

    - `WORKSPACE_ADMIN("workspace_admin")`

    - `WORKSPACE_BILLING("workspace_billing")`

    - `WORKSPACE_DEVELOPER("workspace_developer")`

    - `WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")`

    - `WORKSPACE_USER("workspace_user")`

### Example

```java
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.workspaces.WorkspaceMember;
import com.anthropic.models.organization.workspaces.WorkspaceRole;
import com.anthropic.models.organization.workspaces.members.MemberUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        MemberUpdateParams params = MemberUpdateParams.builder()
            .workspaceId("workspace_id")
            .userId("user_id")
            .workspaceRole(WorkspaceRole.WORKSPACE_ADMIN)
            .build();
        WorkspaceMember workspaceMember = client.organization().workspaces().members().update(params);
    }
}
```

#### Response (200)

```json
{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_admin"
}
```

## Delete Workspace Member

`MemberRemoveResponse organization().workspaces().members().remove(params, requestOptions = RequestOptions.none())`

**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}`

Delete Workspace Member

### Parameters

- `MemberRemoveParams params`

  - `String workspaceId` (path parameter)

    ID of the Workspace.

  - `Optional<String> userId` (path parameter)

    ID of the User.

### Returns

- `class MemberRemoveResponse`

  - `JsonValue type = "workspace_member_deleted"`

    Deleted object type.

    For Workspace Members, this is always `"workspace_member_deleted"`.

  - `String userId`

    ID of the User.

  - `String workspaceId`

    ID of the Workspace.

### Example

```java
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.workspaces.members.MemberRemoveParams;
import com.anthropic.models.organization.workspaces.members.MemberRemoveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        MemberRemoveParams params = MemberRemoveParams.builder()
            .workspaceId("workspace_id")
            .userId("user_id")
            .build();
        MemberRemoveResponse member = client.organization().workspaces().members().remove(params);
    }
}
```

#### Response (200)

```json
{
  "type": "workspace_member_deleted",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}
```