ListSCMOrganizations

POST/gitpod.v1.RunnerService/ListSCMOrganizations

Lists SCM organizations the user belongs to.

Use this method to:

Get all organizations for a user on a specific SCM host
Check organization admin permissions for webhook creation

Examples

List GitHub organizations:

Lists all organizations the user belongs to on GitHub.
```
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
scmHost: "github.com"
```

Search GitLab groups:

Returns the first page of GitLab groups matching the substring.

runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
scmHost: "gitlab.com"
query: "platform"
pagination:
  pageSize: 25

Query ParametersExpand Collapse

token: optional string

pageSize: optional number

maximum100

minimum0

Body ParametersJSONExpand Collapse

pagination: optional object { token, pageSize }

Pagination parameters. When unset, defaults to the standard PaginationRequest defaults (page_size 25, max 100). Tokens are opaque and provider-specific.

token: optional string

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

pageSize: optional number

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

formatint32

maximum100

query: optional string

Optional substring filter applied to the organization name.

GitLab: forwarded to the upstream search parameter (server-side, case-insensitive substring on name/path).
GitHub and Bitbucket: not implemented as they don’t support searching Empty value means no filter.

runnerId: optional string

formatuuid

scmHost: optional string

The SCM host to list organizations from (e.g., “github.com”, “gitlab.com”)

minLength1

ReturnsExpand Collapse

organizations: optional array of object { isAdmin, name, url }

List of organizations the user belongs to

DeprecatedisAdmin: optional boolean

Deprecated: this field is unused by all known consumers and is scheduled for removal in a future release. Do not read it.

Originally intended to gate organization-level webhook creation in the dashboard, but that gating was never implemented. Populating this field on the GitLab path requires a second fully-paginated ListGroups call, which is the main reason we are deprecating it.

name: optional string

Organization name/slug (e.g., “gitpod-io”)

url: optional string

Organization URL (e.g., “https://github.com/gitpod-io”)

pagination: optional object { nextToken }

Pagination cursor for fetching the next page. Empty next_token means no more results.

nextToken: optional string

Token passed for retrieving the next set of results. Empty if there are no more results

ListSCMOrganizations

curl https://app.gitpod.io/api/gitpod.v1.RunnerService/ListSCMOrganizations \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'

{
  "organizations": [
    {
      "isAdmin": true,
      "name": "name",
      "url": "url"
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}

Returns Examples

{
  "organizations": [
    {
      "isAdmin": true,
      "name": "name",
      "url": "url"
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}