Get GitHub App Installations Endpoint

Overview

This endpoint retrieves all GitHub App installations associated with a specific user.

Request Details

HTTP Method

GET

Route

/api/users/[user_id]/installations

Route Parameters

Parameter	Type	Required	Description
user_id	string	Yes	Unique identifier of the user

Headers

Header	Value	Required	Description
Cookie	neptun-session	Yes	Session authentication cookie

Query Parameters

No query parameters required.

Request Body

No request body required.

Response Format

Success Response (200 OK)

[
  {
    "id": 1,
    "neptun_user_id": "user123",
    "github_installation_id": "12345678",
    "created_at": "2024-03-20T10:00:00Z",
    "updated_at": "2024-03-20T10:00:00Z"
  }
]

Error Response (404 Not Found)

{
  "statusCode": 404,
  "statusMessage": "Not Found",
  "data": {
    "message": "User not found"
  }
}

TypeScript Interfaces

interface GithubAppInstallation {
  id: number
  neptun_user_id: string
  github_installation_id: string
  created_at: string
  updated_at: string
}

interface GetInstallationsError {
  statusCode: number
  statusMessage: string
  data: {
    message: string
  }
}

Python Models

from pydantic import BaseModel
from datetime import datetime

class GithubAppInstallation(BaseModel):
    id: int
    neptun_user_id: str
    github_installation_id: str
    created_at: datetime
    updated_at: datetime

class GetInstallationsError(BaseModel):
    statusCode: int
    statusMessage: str
    data: dict[str, str]

Code Examples

Python Example (using httpx)

from typing import List

async def get_github_installations(
    user_id: str,
    session_cookie: str
) -> List[GithubAppInstallation]:
    async with httpx.AsyncClient() as client:
        response = await client.get(
            f"https://neptun-webui.vercel.app/api/users/{user_id}/installations",
            cookies={"neptun-session": session_cookie}
        )
        response.raise_for_status()
        return [GithubAppInstallation(**installation) for installation in response.json()]

cURL Example

curl -X GET \
  -H "Cookie: neptun-session=your-session-cookie" \
  "https://neptun-webui.vercel.app/api/users/your-user-id/installations"

TypeScript/JavaScript Example (using fetch)

async function getGithubInstallations(
  userId: string
): Promise<GithubAppInstallation[]> {
  const response = await fetch(
    `https://neptun-webui.vercel.app/api/users/${userId}/installations`,
    {
      credentials: 'include', // Important for cookie handling
    }
  )

  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`)
  }

  return await response.json() as GithubAppInstallation[]
}

Response Status Codes

Status Code	Description
200	Successfully retrieved installations
401	Unauthorized (invalid or missing session)
404	User not found
500	Server error

Notes

• The session cookie is required for authentication
• Returns an empty array if no installations are found
• Each installation represents a GitHub App installation in a repository or organization
• The github_installation_id is the unique identifier provided by GitHub
• Installation data includes creation and last update timestamps