Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations

Invites

CreateOrganizationInvite
client.organizations.invites.create(InviteCreateParams { organizationId } body, RequestOptionsoptions?): InviteCreateResponse { invite }
POST/gitpod.v1.OrganizationService/CreateOrganizationInvite
GetOrganizationInviteSummary
client.organizations.invites.getSummary(InviteGetSummaryParams { inviteId } body, RequestOptionsoptions?): InviteGetSummaryResponse { organizationId, organizationMemberCount, organizationName }
POST/gitpod.v1.OrganizationService/GetOrganizationInviteSummary
GetOrganizationInvite
client.organizations.invites.retrieve(InviteRetrieveParams { organizationId } body, RequestOptionsoptions?): InviteRetrieveResponse { invite }
POST/gitpod.v1.OrganizationService/GetOrganizationInvite
ModelsExpand Collapse
OrganizationInvite { inviteId }
inviteId: string

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

formatuuid
InviteCreateResponse { invite }
invite: OrganizationInvite { inviteId }
inviteId: string

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

formatuuid
InviteGetSummaryResponse { organizationId, organizationMemberCount, organizationName }
organizationId: string
formatuuid
organizationMemberCount?: number
formatint32
organizationName?: string
InviteRetrieveResponse { invite }
invite: OrganizationInvite { inviteId }
inviteId: string

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

formatuuid