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)

1
{
2
  "data": [
3
    {
4
      "type": "github_connection",
5
      "id": "7",
6
      "attributes": {
7
        "inserted_at": "lorem",
8
        "updated_at": "lorem",
9
        "installation_id": 42,
10
        "workdir": "lorem",
11
        "supabase_changes_only": true,
12
        "branch_limit": 42,
13
        "new_branch_per_pr": true,
14
        "project": {
15
          "id": 42,
16
          "ref": "abcdefghijklmnopqrst",
17
          "name": "lorem"
18
        },
19
        "repository": {
20
          "id": 42,
21
          "name": "lorem"
22
        },
23
        "user": {
24
          "id": 42,
25
          "username": "lorem",
26
          "primary_email": "lorem"
27
        }
28
      }
29
    }
30
  ],
31
  "links": {
32
    "first": "/v2/organizations/my-org/integrations/github/connections?page[size]=10",
33
    "prev": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
34
    "next": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
35
    "last": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295"
36
  }
37
}