One change
Members
api/admin/workspaces/members
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/workspaces/members Changed · +56 / -59 lines
### Path parameters ### Body parameters #### Response (200) ### Path parameters #### Response (200) ### Path parameters ### Query parameters #### Response (200) ### Path parameters ### Body parameters #### Response (200) ### Path parameters #### Response (200) ## Domain types ### Path Parameters ### Body Parameters #### Response ### Path Parameters #### Response ### Path Parameters ### Query Parameters #### Response ### Path Parameters ### Body Parameters #### Response ### Path Parameters #### Response ## Domain Types
from line 1
---- -title: Members -url: https://platform.claude.com/docs/en/api/admin/workspaces/members ---- - # Members ## Create Workspace Member -**post** `/v1/organizations/workspaces/{workspace_id}/members` +**POST** `/v1/organizations/workspaces/{workspace_id}/members` Create Workspace Member -### Path Parameters +### Path parameters - `workspace_id: string` ID of the Workspace. -### Body Parameters +### Body parameters - `user_id: string`
from line 32
### Returns -- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }` +- `WorkspaceMember object` - `type: "workspace_member"`
from line 40
For Workspace Members, this is always `"workspace_member"`. - - `"workspace_member"` + default: workspace_member - `user_id: string`
from line 66
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
from line 77
}' ``` -#### Response +#### Response (200) ```json {
from line 90
## Get Workspace Member -**get** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` +**GET** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Get Workspace Member -### Path Parameters +### Path parameters - `workspace_id: string`
from line 106
### Returns -- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }` +- `WorkspaceMember object` - `type: "workspace_member"`
from line 114
For Workspace Members, this is always `"workspace_member"`. - - `"workspace_member"` + default: workspace_member - `user_id: string`
from line 140
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
from line 159
## List Workspace Members -**get** `/v1/organizations/workspaces/{workspace_id}/members` +**GET** `/v1/organizations/workspaces/{workspace_id}/members` List Workspace Members -### Path Parameters +### Path parameters - `workspace_id: string` ID of the Workspace. -### Query Parameters +### Query parameters - `after_id: optional string`
from line 185
Defaults to `20`. Ranges from `1` to `1000`. + default: 20, maximum: 1000, minimum: 1 + ### Returns - `data: array of WorkspaceMember`
from line 197
For Workspace Members, this is always `"workspace_member"`. - - `"workspace_member"` + default: workspace_member - `user_id: string`
from line 235
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \ -H 'anthropic-version: 2023-06-01' \ -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
from line 261
## Update Workspace Member -**post** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` +**POST** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Update Workspace Member -### Path Parameters +### Path parameters - `workspace_id: string`
from line 275
ID of the User. -### Body Parameters +### Body parameters - `workspace_role: "workspace_admin" or "workspace_billing" or "workspace_developer" or 2 more`
from line 293
### Returns -- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }` +- `WorkspaceMember object` - `type: "workspace_member"`
from line 301
For Workspace Members, this is always `"workspace_member"`. - - `"workspace_member"` + default: workspace_member - `user_id: string`
from line 327
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
from line 337
}' ``` -#### Response +#### Response (200) ```json {
from line 350
## Delete Workspace Member -**delete** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` +**DELETE** `/v1/organizations/workspaces/{workspace_id}/members/{user_id}` Delete Workspace Member -### Path Parameters +### Path parameters - `workspace_id: string`
from line 372
For Workspace Members, this is always `"workspace_member_deleted"`. - - `"workspace_member_deleted"` + default: workspace_member_deleted - `user_id: string`
from line 384
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \ -X DELETE \ -H 'anthropic-version: 2023-06-01' \
from line 391
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +#### Response (200) ```json {
from line 401
} ``` -## Domain Types +## Domain types ### Workspace Member -- `WorkspaceMember object { type, user_id, workspace_id, workspace_role }` +- `WorkspaceMember object` - `type: "workspace_member"`
from line 413
For Workspace Members, this is always `"workspace_member"`. - - `"workspace_member"` + default: workspace_member - `user_id: string`
from line 439
### Member Delete Response -- `MemberDeleteResponse object { type, user_id, workspace_id }` +- `MemberDeleteResponse object` - `type: "workspace_member_deleted"`
from line 447
For Workspace Members, this is always `"workspace_member_deleted"`. - - `"workspace_member_deleted"` + default: workspace_member_deleted - `user_id: string`