Get a project mapping

GET/api/v2/workspaces/{slug}/group-sync/project-mappings/{pk}/

Group sync maps identity-provider groups onto Plane workspace and project roles. Read a single project mapping by id.

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 project mapping id.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: all_projects, created_at, id, idp_group_name, project_id, role_slug.

Scopes

workspaces.group_sync:read

Errors

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
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.

Get a project mapping

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/group-sync/project-mappings/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

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

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/group-sync/project-mappings/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "all_projects": false,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "idp_group_name": "example",
  "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "role_slug": "example"
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "No project mapping matches the given query."
}