Skip to content
Ona Docs

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"
Query ParametersExpand Collapse
token: optional string
pageSize: optional number
maximum100
minimum0
Body ParametersJSONExpand Collapse
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

isAdmin: optional boolean

Whether the user has admin permissions in this organization. Admin permissions typically allow creating organization-level webhooks.

name: optional string

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

url: optional string

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

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"
    }
  ]
}
Returns Examples
{
  "organizations": [
    {
      "isAdmin": true,
      "name": "name",
      "url": "url"
    }
  ]
}