---
title: "GET /api/v1/organizations/{organization_id}/github_onboarding"
method: GET
path: "/api/v1/organizations/{organization_id}/github_onboarding"
tags: ["organizations"]
---

# GET /api/v1/organizations/{organization_id}/github_onboarding

`GET /api/v1/organizations/{organization_id}/github_onboarding`

## Request

- Base URL: `https://composal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://composal.com/api/v1/organizations/{organization_id}/github_onboarding`
- Auth: HTTP bearer

## Path parameters

- `organization_id` string, required

## Response `200`

GitHub onboarding state

- GithubOnboardingState
  - `installations` object[], required
    - `id` string, required
    - `organization_id` string, required
    - `installation_id` string, required
    - `account_login` string, required
    - `account_id` string, nullable, required
    - `account_avatar_url` string, uri, nullable, required
    - `manage_access_url` string, uri, required
    - `status` 'active' | 'suspended', required
    - `permissions` object, required
    - `permission_entries` object[], required
      - `key` string, required
      - `name` string, required
      - `access` string, required
    - `installed_at` string, date-time, nullable, required
    - `suspended_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `installed_at_label` string, nullable, required
    - `suspended_at_label` string, nullable, required
    - `created_at_label` string, nullable, required
    - `updated_at_label` string, nullable, required
  - `accounts` object[], required
    - `github_app_installation_id` string, required
    - `account_login` string, required
    - `repositories` object[], required
      - `owner` string, required
      - `name` string, required
      - `full_name` string, required
      - `default_branch` string, required
      - `visibility` string, required
      - `private` boolean, required
      - `empty` boolean, nullable, required
      - `html_url` string, uri, required
      - `updated_at` string, nullable, required
      - `already_imported` boolean, required
  - `batches` GithubImportBatch[], required
    - `id` string, required
    - `github_app_installation_id` string, required
    - `account_login` string, required
    - `status` 'running' | 'completed', required
    - `complete` boolean, required: Whether every item has settled and the wizard should treat the import as finished.
    - `item_count` integer, required
    - `terminal_item_count` integer, required
    - `failed_item_count` integer, required
    - `imported_item_count` integer, required
    - `items` object[], required
      - `id` string, required
      - `repository_id` string, nullable, required
      - `repository_owner` string, required
      - `repository_name` string, required
      - `repository_full_name` string, required
      - `root_path` string, required
      - `include_in_home` boolean, required
      - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'already_imported' | 'invalid', required
      - `terminal` boolean, required: Whether this item has settled (no further work expected without a retry).
      - `error_message` string, nullable, required
      - `repository_slug` string, nullable, required
      - `phase` string, required
      - `can_retry` boolean, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `active_batch_id` string, nullable, required: The batch the wizard's import step should resume — the most recent batch still working, else the most recent overall.
  - `capabilities` object, required
    - `can_manage_connections` boolean, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Unprocessable entity
- `502`: Bad gateway

---

[API](https://skmtc.dev/composal/apis/vex-api.md) - [All operations](https://skmtc.dev/composal/apis/vex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/composal/apis/vex-api/revisions/74298a24e040?raw)