Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations
Invites

GetOrganizationInviteSummary

organizations.invites.get_summary(InviteGetSummaryParams**kwargs) -> InviteGetSummaryResponse
POST/gitpod.v1.OrganizationService/GetOrganizationInviteSummary

Retrieves organization details and membership info based on an invite link.

Use this method to:

  • Preview organization details before joining
  • Validate invite link authenticity
  • Check organization size and activity
  • View team information before accepting

Examples

  • Get invite summary:

    Retrieves organization information from an invite.

    inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
invite_id: str
formatuuid
ReturnsExpand Collapse
class InviteGetSummaryResponse: …
organization_id: str
formatuuid
organization_member_count: Optional[int]
formatint32
organization_name: Optional[str]

GetOrganizationInviteSummary

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.organizations.invites.get_summary(
    invite_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(response.organization_id)
{
  "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "organizationMemberCount": 0,
  "organizationName": "organizationName"
}
Returns Examples
{
  "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "organizationMemberCount": 0,
  "organizationName": "organizationName"
}