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

GetOrganizationInvite

organizations.invites.retrieve(InviteRetrieveParams**kwargs) -> InviteRetrieveResponse
POST/gitpod.v1.OrganizationService/GetOrganizationInvite

GetOrganizationInvite

ParametersExpand Collapse
organization_id: str
formatuuid
ReturnsExpand Collapse
class InviteRetrieveResponse: …
invite_id: str

invite_id is the unique identifier of the invite to join the organization. Use JoinOrganization with this ID to join the organization.

formatuuid

GetOrganizationInvite

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
invite = client.organizations.invites.retrieve(
    organization_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(invite.invite)
{
  "invite": {
    "inviteId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}
Returns Examples
{
  "invite": {
    "inviteId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}