latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

All Invitations

Return a list containing details of all pending invitation to a workspace.

This list is not paginated. All workspace members can access this list.

get/api/v1/workspaces/invitations/all

Query parameters

workspace_idinteger required

ID of the workspace.

Example:123456

Response

Successful Response

inviter_idstring required

ID of the user user who sent the invitation

user_emailstring required

The invited person's email.

workspace_idstring required

ID of the workspace

role'ADMIN' | 'MEMBER' | 'GUEST' required

Role of the user inside the workspace

idstring

The ID of the invitation

Example response

[
  {
    "inviter_id": "1029384756",
    "user_email": "foo@example.com",
    "workspace_id": "12345",
    "id": "234"
  }
]