Create an invitation

POST/api/v2/workspaces/{slug}/invitations/

Invitations are pending workspace membership offers. Create an invitation.

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.

Body Parameters

email:requiredstring (email)

Email address.

message:optionalstring

The message.

Nullable.

role:optionalstring

Role to grant.

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: accepted, created_at, created_by_id, email, id, message, responded_at, role.

Scopes

workspaces.members:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
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.
409	conflict	A business rule blocks the write — see the notes above.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Create an invitation

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/invitations/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "ana@example.com",
  "message": "example",
  "role": "example"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/invitations/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "email": "ana@example.com",
        "message": "example",
        "role": "example"
    },
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v2/workspaces/my-team/invitations/", {
  method: "POST",
  headers: {
    "X-Api-Key": "your-api-key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    email: "ana@example.com",
    message: "example",
    role: "example",
  }),
});
const data = await response.json();

Response201

{
  "accepted": false,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "email": "ana@example.com",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "message": "example",
  "responded_at": "2026-01-14T09:22:41.478363Z",
  "role": "example"
}