Skip to content
Management API Reference

List GitHub connections of an organization

get/v2/organizations/{slug}/integrations/github/connections

Returns a cursor-paginated list of the GitHub connections of the organization's projects.

Use page[after] and page[before] to navigate pages and page[size] to control the page size. Paging walks the organization projects, so a page holds at most page[size] connections and can hold fewer (or none) when some of its projects are not connected. Follow links.next until it is null rather than stopping on a short page.

Use filter[project_ref] to narrow the list down to a single project.

OAuth scopes

  • projects:read

The fine-grained token must include the following permissions to access this endpoint:

  • organization_projects_read

Path parameters

  • slug
    Required
    string

    Organization slug

Query parameters

  • page
    Optional
    object
  • filter
    Optional
    object

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
  "data": [
    {
      "type": "github_connection",
      "id": "7",
      "attributes": {
        "inserted_at": "lorem",
        "updated_at": "lorem",
        "installation_id": 42,
        "workdir": "lorem",
        "supabase_changes_only": true,
        "branch_limit": 42,
        "new_branch_per_pr": true,
        "project": {
          "id": 42,
          "ref": "abcdefghijklmnopqrst",
          "name": "lorem"
        },
        "repository": {
          "id": 42,
          "name": "lorem"
        },
        "user": {
          "id": 42,
          "username": "lorem",
          "primary_email": "lorem"
        }
      }
    }
  ],
  "links": {
    "first": "/v2/organizations/my-org/integrations/github/connections?page[size]=10",
    "prev": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
    "next": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
    "last": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
  }
}