List a teamspace's members

GET/api/v2/workspaces/{slug}/teamspaces/{pk}/members/

Return the members of a teamspace, paginated. The teamspace's member_ids holds only user ids. Add ?expand=member to get each member's display name, email, and avatar URL in the same call.

Each row is the user's workspace membership, the same shape as List workspace members: the membership id, the user's member_id, and their workspace role. A teamspace membership has no role of its own. Only active workspace members appear, so a user who has left the workspace drops out of this list even if their id is still on the teamspace.

A teamspace you can't see returns 404. Seeing the teamspace is enough to see its members.

Read-only route

This route is GET only. To change who is in the teamspace, send member_ids on Update a teamspace. It replaces the whole set, and the user making the call always stays in it. A POST here returns 405 method_not_allowed.

The list takes no filters and no search.

Path parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The teamspace whose members you want to list.

Ordering

Rows come back in a fixed order, newest first by when each user joined the workspace, with id as the tiebreaker. The order is not configurable, and an order_by you send is ignored.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Use the next value from the response instead of computing offsets yourself.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then omitted from the response.

Response shaping

fields:optionalstring

Comma-separated list of fields to return on each row. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: id, member_id, role.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: member (the user, with id, display_name, avatar_url, and email).

Each expanded relation gets its own key: ?expand=member keeps member_id and adds a member object next to it, so an id is never replaced by an object. An unknown value returns 400.

?fields= and ?expand= take separate sets of names. A relation name is not a valid ?fields= value, a field name is not a valid ?expand= value, and field filtering never removes an expanded object. See Expanding relations.

Scopes

teamspaces:read

Errors

Status	Code	Cause
400	invalid_request	An unknown name in fields or expand.
401	unauthorized	Missing or invalid credentials.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such teamspace, you can't see it, or it's outside your tenant.
405	method_not_allowed	You sent a method other than GET. Write members inline on the teamspace instead.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

List a teamspace's members

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/teamspaces/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/members/?expand=member" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/teamspaces/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/members/",
    headers={"X-Api-Key": "your-api-key"},
    params={"expand": "member"},
)
print(response.json())

const params = new URLSearchParams({ expand: "member" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/teamspaces/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/members/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "3e8a5d17-9c40-4b2f-81d6-4a7f2b9e0c53",
      "member_id": "7f2b9e04-6c1d-4a58-9e3b-0d4c8a2f6b71",
      "role": "member",
      "member": {
        "id": "7f2b9e04-6c1d-4a58-9e3b-0d4c8a2f6b71",
        "display_name": "Devansh Kapoor",
        "avatar_url": null,
        "email": "devansh@example.com"
      }
    },
    {
      "id": "c1b7e4a9-2f66-4a1d-9c3b-7d5e2f8a1b40",
      "member_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "role": "owner",
      "member": {
        "id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
        "display_name": "Priya Raghavan",
        "avatar_url": "https://assets.plane.so/avatars/16c61a3a.png",
        "email": "priya@example.com"
      }
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response200

{
  "data": [
    {
      "id": "3e8a5d17-9c40-4b2f-81d6-4a7f2b9e0c53",
      "member_id": "7f2b9e04-6c1d-4a58-9e3b-0d4c8a2f6b71",
      "role": "member"
    },
    {
      "id": "c1b7e4a9-2f66-4a1d-9c3b-7d5e2f8a1b40",
      "member_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "role": "owner"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}