Skip to main content
GET
/
v1
/
github
/
installation
Get GitHub installation
curl --request GET \
  --url https://api.example.com/v1/github/installation

​
Overview

Returns details about the GitHub App installation associated with the current tenant, including which repositories are accessible and what permissions have been granted. Required role: admin

​
Response

Returns 200 OK with the GitHub App installation details. 
{
  "installationId": 12345678,
  "accountLogin": "acme-corp",
  "repositories": [
    {
      "repositoryId": 987654321,
      "name": "backend-api",
      "fullName": "acme-corp/backend-api",
      "private": true
    },
    {
      "repositoryId": 987654322,
      "name": "frontend",
      "fullName": "acme-corp/frontend",
      "private": false
    }
  ],
  "permissions": {
    "contents": "read",
    "pull_requests": "write"
  }
}
FieldTypeDescription
installationIdintegerThe GitHub App installation ID
accountLoginstringThe GitHub account (organization or user) that installed the app
repositoriesarrayList of repositories the installation has access to
repositories[].repositoryIdintegerThe GitHub repository ID
repositories[].namestringThe repository name
repositories[].fullNamestringThe full repository name including owner: owner/repo
repositories[].privatebooleanWhether the repository is private
permissions.contentsstringPermission level for repository contents: read or write
permissions.pull_requestsstringPermission level for pull requests: read or write

​
Error responses

StatusError codeDescription
403forbiddenThe authenticated user does not have admin role
404not_foundNo GitHub App installation exists for this tenant

​
Examples

curl https://api.causeflow.ai/v1/github/installation \
  -H "Authorization: Bearer <token>"