Add members to teamspace

POST/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/members/

Add users to a teamspace. Users who are already members are skipped.

Requires the teamspace lead, or a workspace Owner or Admin. The response is a list with a user object for every ID in member_ids, including users who were already members.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

teamspace_id:requiredstring

The unique identifier of the teamspace.

Body Parameters

member_ids:requiredarray

IDs of the users to add. An empty or missing list adds nobody and still returns 200 with an empty list.

Scopes

write, or both teamspaces:write and teamspaces.members:write. The teamspaces.members:write scope alone is not enough.

Add members to teamspace

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/members/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "member_ids": [
    "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
  ]
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/members/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "member_ids": [
        "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
      ]
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/members/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      member_ids: ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
    }),
  },
);
const data = await response.json();

Response200

[
  {
    "id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
    "first_name": "John",
    "last_name": "Doe",
    "email": "user@example.com",
    "avatar": "",
    "avatar_url": "https://example.com/assets/example-image.png",
    "display_name": "john"
  }
]