List workspace group mappings

GET/api/v1/workspaces/{workspace_slug}/group-sync/workspace-mappings/

Retrieve all IdP group → workspace role mappings for the workspace.

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.

Scopes

workspaces.group_sync:read

List workspace group mappings

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/" \
  -H "X-API-Key: $PLANE_API_KEY"
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/", {
  headers: {
    "X-API-Key": "your-api-key",
  },
});
const data = await response.json();

Response200

[
  {
    "id": "772g0622-g41d-63f6-c938-668877662222",
    "idp_group_name": "leadership",
    "role": "admin",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  },
  {
    "id": "883h1733-h52e-74g7-d049-779988773333",
    "idp_group_name": "engineering",
    "role": "member",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
]