ListJoinableOrganizations

accounts.list_joinable_organizations() -> SyncJoinableOrganizationsPage[JoinableOrganization]

POST/gitpod.v1.AccountService/ListJoinableOrganizations

Lists organizations that the currently authenticated account can join.

Use this method to:

Discover organizations associated with the account’s email domain.
Allow users to join existing organizations.
Display potential organizations during onboarding.

Examples

List joinable organizations:

Retrieves a list of organizations the account can join.
```
{}
```

ParametersExpand Collapse

token: Optional[str]

page_size: Optional[int]

maximum100

minimum0

pagination: Optional[Pagination]

pagination contains the pagination options for listing joinable organizations

token: Optional[str]

Token for the next set of results that was returned as next_token of a PaginationResponse

page_size: Optional[int]

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

ReturnsExpand Collapse

class JoinableOrganization: …

organization_id: str

organization_id is the id of the organization the user can join

formatuuid

organization_name: str

organization_name is the name of the organization the user can join

organization_member_count: Optional[int]

organization_member_count is the member count of the organization the user can join

formatint32

ListJoinableOrganizations

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.accounts.list_joinable_organizations()
page = page.joinable_organizations[0]
print(page.organization_id)

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "joinableOrganizations": [
    {
      "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "organizationName": "organizationName",
      "organizationMemberCount": 0
    }
  ]
}

Returns Examples

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "joinableOrganizations": [
    {
      "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "organizationName": "organizationName",
      "organizationMemberCount": 0
    }
  ]
}