Plane DocsSign in

Invitations overview ​

Invitations are pending workspace membership offers.

The invitation object ​

Attributes ​

  • accepted boolean

    Whether accepted.

  • created_at string (date-time)

    When the record was created.

  • created_by_id string (uuid)

    The user who created the record.

  • email string

    Email address.

  • id string (uuid)

    Unique identifier.

  • message string

    The message.

  • responded_at string (date-time)

    The responded at.

  • role string

    Role to grant.

Response200
json
{
  "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"
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/invitations/List invitations
GET/api/v2/workspaces/{slug}/invitations/{pk}/Get an invitation
POST/api/v2/workspaces/{slug}/invitations/Create an invitation
DELETE/api/v2/workspaces/{slug}/invitations/{pk}/Delete an invitation
POST/api/v2/workspaces/{slug}/invitations/bulk/Bulk invite members

Response shaping ​

Every invitation read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.