GetOrganizationInviteSummary

client.organizations.invites.getSummary(, ?): InviteGetSummaryResponse { organizationId, organizationMemberCount, organizationName }

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

body: InviteGetSummaryParams { inviteId }

inviteId: string

formatuuid

ReturnsExpand Collapse

InviteGetSummaryResponse { organizationId, organizationMemberCount, organizationName }

organizationId: string

formatuuid

organizationMemberCount?: number

formatint32

organizationName?: string

GetOrganizationInviteSummary

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const response = await client.organizations.invites.getSummary({
  inviteId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

console.log(response.organizationId);

{
  "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "organizationMemberCount": 0,
  "organizationName": "organizationName"
}

Returns Examples

{
  "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "organizationMemberCount": 0,
  "organizationName": "organizationName"
}