GetOrganizationInviteSummary

client.Organizations.Invites.GetSummary(ctx, body) (*OrganizationInviteGetSummaryResponse, error)

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 OrganizationInviteGetSummaryParams

InviteID param.Field[string]

formatuuid

ReturnsExpand Collapse

type OrganizationInviteGetSummaryResponse struct{…}

OrganizationID string

formatuuid

OrganizationMemberCount int64Optional

formatint32

OrganizationName stringOptional

GetOrganizationInviteSummary

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Organizations.Invites.GetSummary(context.TODO(), gitpod.OrganizationInviteGetSummaryParams{
    InviteID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.OrganizationID)
}

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

Returns Examples

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