# Invites

## CreateOrganizationInvite

`organizations.invites.create(InviteCreateParams**kwargs)  -> InviteCreateResponse`

**post** `/gitpod.v1.OrganizationService/CreateOrganizationInvite`

Creates an invite link for joining an organization.
Any existing OrganizationInvites are invalidated and can no longer be used.

Use this method to:

- Generate shareable invite links
- Manage team growth
- Control organization access

### Examples

- Create organization invite:

  Generates a new invite link for the organization.

  ```yaml
  organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
  ```

### Parameters

- `organization_id: str`

### Returns

- `class InviteCreateResponse: …`

  - `invite: OrganizationInvite`

    - `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.

### Example

```python
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.create(
    organization_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
)
print(invite.invite)
```

#### Response

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

## 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.

  ```yaml
  inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  ```

### Parameters

- `invite_id: str`

### Returns

- `class InviteGetSummaryResponse: …`

  - `organization_id: str`

  - `organization_member_count: Optional[int]`

  - `organization_name: Optional[str]`

### Example

```python
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)
```

#### Response

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

## GetOrganizationInvite

`organizations.invites.retrieve(InviteRetrieveParams**kwargs)  -> InviteRetrieveResponse`

**post** `/gitpod.v1.OrganizationService/GetOrganizationInvite`

GetOrganizationInvite

### Parameters

- `organization_id: str`

### Returns

- `class InviteRetrieveResponse: …`

  - `invite: OrganizationInvite`

    - `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.

### Example

```python
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)
```

#### Response

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

## Domain Types

### Organization Invite

- `class OrganizationInvite: …`

  - `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.

### Invite Create Response

- `class InviteCreateResponse: …`

  - `invite: OrganizationInvite`

    - `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.

### Invite Get Summary Response

- `class InviteGetSummaryResponse: …`

  - `organization_id: str`

  - `organization_member_count: Optional[int]`

  - `organization_name: Optional[str]`

### Invite Retrieve Response

- `class InviteRetrieveResponse: …`

  - `invite: OrganizationInvite`

    - `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.