Get workspace invitation

GET/api/v1/workspaces/{workspace_slug}/invitations/{invitation_id}/

Get a workspace invite by ID

Path Parameters

invitation_id:requiredstring

The unique identifier of the invitation.

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

Workspace admin or owner permission required.

Get workspace invitation

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/invitations/invitation-uuid/" \
  -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/invitations/invitation-uuid/",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

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

Response200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "Example Name",
  "role": 20,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "responded_at": "2024-01-01T00:00:00Z",
  "accepted": true
}