List organization github connections | 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

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
}

1
{
2
  "type": "object",
3
  "properties": {
4
    "data": {
5
      "type": "array",
6
      "items": {
7
        "type": "object",
8
        "properties": {
9
          "type": {
10
            "type": "string",
11
            "description": "Resource type.",
12
            "enum": [
13
              "github_connection"
14
            ]
15
          },
16
          "id": {
17
            "type": "string",
18
            "description": "Connection id.",
19
            "example": "7"
20
          },
21
          "attributes": {
22
            "type": "object",
23
            "properties": {
24
              "inserted_at": {
25
                "type": "string",
26
                "description": "When the connection was created"
27
              },
28
              "updated_at": {
29
                "type": "string",
30
                "description": "When the connection was last updated"
31
              },
32
              "installation_id": {
33
                "type": "number",
34
                "description": "GitHub App installation id"
35
              },
36
              "workdir": {
37
                "type": "string",
38
                "description": "Directory within the repository the project lives in"
39
              },
40
              "supabase_changes_only": {
41
                "type": "boolean",
42
                "description": "Whether branches are only created for changes under `supabase/`"
43
              },
44
              "branch_limit": {
45
                "type": "number",
46
                "description": "Maximum number of preview branches"
47
              },
48
              "new_branch_per_pr": {
49
                "type": "boolean",
50
                "description": "Whether a preview branch is created for every pull request"
51
              },
52
              "project": {
53
                "type": "object",
54
                "properties": {
55
                  "id": {
56
                    "type": "number"
57
                  },
58
                  "ref": {
59
                    "type": "string",
60
                    "minLength": 20,
61
                    "maxLength": 20,
62
                    "pattern": "^[a-z]+$",
63
                    "description": "Project ref",
64
                    "example": "abcdefghijklmnopqrst"
65
                  },
66
                  "name": {
67
                    "type": "string"
68
                  }
69
                },
70
                "required": [
71
                  "id",
72
                  "ref",
73
                  "name"
74
                ],
75
                "description": "The connected Supabase project"
76
              },
77
              "repository": {
78
                "type": "object",
79
                "properties": {
80
                  "id": {
81
                    "type": "number"
82
                  },
83
                  "name": {
84
                    "type": "string"
85
                  }
86
                },
87
                "required": [
88
                  "id",
89
                  "name"
90
                ],
91
                "description": "The connected GitHub repository"
92
              },
93
              "user": {
94
                "type": "object",
95
                "properties": {
96
                  "id": {
97
                    "type": "number"
98
                  },
99
                  "username": {
100
                    "type": "string"
101
                  },
102
                  "primary_email": {
103
                    "type": "string",
104
                    "nullable": true
105
                  }
106
                },
107
                "required": [
108
                  "id",
109
                  "username",
110
                  "primary_email"
111
                ],
112
                "description": "The user who created the connection, if still known",
113
                "nullable": true
114
              }
115
            },
116
            "required": [
117
              "inserted_at",
118
              "updated_at",
119
              "installation_id",
120
              "workdir",
121
              "supabase_changes_only",
122
              "branch_limit",
123
              "new_branch_per_pr",
124
              "project",
125
              "repository",
126
              "user"
127
            ]
128
          }
129
        },
130
        "required": [
131
          "type",
132
          "id",
133
          "attributes"
134
        ]
135
      }
136
    },
137
    "links": {
138
      "type": "object",
139
      "properties": {
140
        "first": {
141
          "type": "string",
142
          "description": "URL path to the first page if available.",
143
          "example": "/v2/organizations/my-org/integrations/github/connections?page[size]=10",
144
          "nullable": true
145
        },
146
        "prev": {
147
          "type": "string",
148
          "description": "URL path to the previous page.",
149
          "example": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[before]=019adf7d-4513-74c5-bb9a-f1bc0f7a95d7",
150
          "nullable": true
151
        },
152
        "next": {
153
          "type": "string",
154
          "description": "URL path to the next page.",
155
          "example": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[after]=019adf7d-4513-7062-b292-78b86cc470a4",
156
          "nullable": true
157
        },
158
        "last": {
159
          "type": "string",
160
          "description": "URL path to the last page if available.",
161
          "example": "/v2/organizations/my-org/integrations/github/connections?page[size]=10&page[after]=019adf7d-4513-71ba-b264-21900edb4295",
162
          "nullable": true
163
        }
164
      },
165
      "required": [
166
        "prev",
167
        "next"
168
      ]
169
    }
170
  },
171
  "required": [
172
    "data",
173
    "links"
174
  ]
175
}