API Reference

Organizations

Invites

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

GetOrganizationInvite

client.organizations.invites.retrieve(InviteRetrieveParams { organizationId } body, RequestOptionsoptions?): InviteRetrieveResponse { invite }

POST/gitpod.v1.OrganizationService/GetOrganizationInvite

GetOrganizationInvite

ParametersExpand Collapse

body: InviteRetrieveParams { organizationId }

organizationId: string

formatuuid

ReturnsExpand Collapse

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

GetOrganizationInvite

TypeScript

HTTP

TypeScript

Python

Go

import Gitpod from '@gitpod/sdk';

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

const invite = await client.organizations.invites.retrieve({
  organizationId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(invite.invite);

200 example

{
  "invite": {
    "inviteId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}

Returns Examples

200 example

{
  "invite": {
    "inviteId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}