Foundational

Foundational Onboarding API

The Onboarding API from Foundational — 5 operation(s) for onboarding.

Documentation GitHub OpenAPI

Operations 6

GET /onboarding/repos List repositories available for the organization #

POST /onboarding/repos/{repo_name}/trigger Trigger the auto-onboarder for a repository #

DELETE /onboarding/repos/{repo_name} Offboard (remove) a repository #

GET /onboarding/powerbi/workspaces List the PowerBI workspaces configured on the organization's PowerBI connector #

POST /onboarding/powerbi/workspaces Add a PowerBI workspace to the organization's PowerBI connector #

DELETE /onboarding/powerbi/workspaces/{workspace_id} Remove a PowerBI workspace from the organization's PowerBI connector #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/foundational:foundational-onboarding-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Foundational Onboarding API
  version: 0.1.0
servers:
- url: /api/v1
tags:
- name: Onboarding
paths:
  /onboarding/repos:
    get:
      tags:
      - Onboarding
      summary: List repositories available for the organization
      description: 'List the organization''s repositories.


        Returns all of the organization''s repositories as a single list — including offboarded (inactive)

        ones that were soft-disabled via ``DELETE /repos/{repo_name}``.'
      operationId: list_org_repos_onboarding_repos_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepoListResponse'
  /onboarding/repos/{repo_name}/trigger:
    post:
      tags:
      - Onboarding
      summary: Trigger the auto-onboarder for a repository
      description: 'Trigger (re-)onboarding for a repository.


        Side effect: if the repo was previously offboarded (via ``DELETE``), this revives it —

        turns scanning back on, flips ``is_active`` back to ``True`` and restores its connectors —

        before queuing the scan.'
      operationId: trigger_repo_onboarding_onboarding_repos__repo_name__trigger_post
      parameters:
      - name: repo_name
        in: path
        required: true
        schema:
          type: string
          description: Repository full name, for example org/repository
          title: Repo Name
        description: Repository full name, for example org/repository
      responses:
        '204':
          description: Successful Response
        '403':
          description: API onboarding is not enabled for this organization
        '404':
          description: Repository not found in the organization
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/repos/{repo_name}:
    delete:
      tags:
      - Onboarding
      summary: Offboard (remove) a repository
      description: 'Offboard a repository: stop scanning it, mark it inactive, and soft-delete its connectors.


        Rows are never hard-deleted, so scan history is preserved; re-triggering onboarding turns

        scanning back on, reactivates the repo and restores its connectors. Org-scoped: returns 404 if

        the repo is not in the caller''s org.'
      operationId: offboard_repo_onboarding_repos__repo_name__delete
      parameters:
      - name: repo_name
        in: path
        required: true
        schema:
          type: string
          description: Repository full name, for example org/repository
          title: Repo Name
        description: Repository full name, for example org/repository
      responses:
        '204':
          description: Successful Response
        '403':
          description: API onboarding is not enabled for this organization
        '404':
          description: Repository not found in the organization
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/powerbi/workspaces:
    get:
      tags:
      - Onboarding
      summary: List the PowerBI workspaces configured on the organization's PowerBI connector
      description: List the workspace ids currently configured on the org's PowerBI connector.
      operationId: list_powerbi_workspaces_onboarding_powerbi_workspaces_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerBIWorkspacesResponse'
        '403':
          description: API onboarding is not enabled for this organization
        '404':
          description: No PowerBI connector is configured for this organization
        '409':
          description: Multiple PowerBI connectors are configured; workspace edits via API are not supported
    post:
      tags:
      - Onboarding
      summary: Add a PowerBI workspace to the organization's PowerBI connector
      description: 'Add a workspace id to the org''s PowerBI connector. Idempotent: a no-op if already present.'
      operationId: add_powerbi_workspace_onboarding_powerbi_workspaces_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PowerBIWorkspaceAddRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerBIWorkspacesResponse'
        '403':
          description: API onboarding is not enabled for this organization
        '404':
          description: No PowerBI connector is configured for this organization
        '409':
          description: Multiple PowerBI connectors are configured; workspace edits via API are not supported
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /onboarding/powerbi/workspaces/{workspace_id}:
    delete:
      tags:
      - Onboarding
      summary: Remove a PowerBI workspace from the organization's PowerBI connector
      description: 'Remove a workspace id from the org''s PowerBI connector.


        Idempotent: a no-op (not a 404) if the id is absent. When the last id is removed, the

        list is reset to ``None`` rather than ``[]`` so the connector resumes autodiscovering

        all authorized workspaces — the extractor treats an explicit empty list as "scan no

        workspaces".'
      operationId: remove_powerbi_workspace_onboarding_powerbi_workspaces__workspace_id__delete
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: PowerBI workspace id (a GUID) to remove
          title: Workspace Id
        description: PowerBI workspace id (a GUID) to remove
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerBIWorkspacesResponse'
        '403':
          description: API onboarding is not enabled for this organization
        '404':
          description: No PowerBI connector is configured for this organization
        '409':
          description: Multiple PowerBI connectors are configured; workspace edits via API are not supported
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    RepoListResponse:
      properties:
        repos:
          items:
            type: string
          type: array
          title: Repos
          description: Repository full names belonging to the organization, including offboarded (inactive) ones
      type: object
      required:
      - repos
      title: RepoListResponse
      description: List of repositories the calling organization has access to.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PowerBIWorkspaceAddRequest:
      properties:
        workspaceId:
          type: string
          format: uuid
          title: Workspaceid
          description: PowerBI workspace id (a GUID), for example 11111111-2222-3333-4444-555555555555
      type: object
      required:
      - workspaceId
      title: PowerBIWorkspaceAddRequest
      description: 'Request body for adding a PowerBI workspace to the org''s connector.


        A body model (rather than a bare path/query param) so future optional fields — e.g.

        the planned ``breaking_change_relevant`` flag (FOU-13522) — can be added without

        breaking existing callers.'
    PowerBIWorkspacesResponse:
      properties:
        workspaceIds:
          items:
            type: string
          type: array
          title: Workspaceids
          description: PowerBI workspace ids configured for scanning on the connector
      type: object
      required:
      - workspaceIds
      title: PowerBIWorkspacesResponse
      description: The PowerBI connector's configured workspace ids after the mutation.