OrbitsDocs
esc
    Open Orbits
    API reference · TeamIntegrations

    Integrations

    The team's integrations and whether each is connected.

    An API token can list the team's integrations. Connecting, changing and disconnecting them (Git providers, Slack, Microsoft Teams, webhooks) holds the team's credentials with other services, so it is done in the dashboard. See Integrations and Git.

    The integration object

    Fields

    • keystringrequired
    • namestringrequired
    • categorystringrequired

      One of source_code, notifications, payments, monitoring.

    • descriptionstring
    • availableboolean

      False when the integration is listed but cannot be installed yet.

    • installedbooleanrequired
    • statusstring or null

      One of connected, needs_attention.

    • summarystring or null

      One line for the Installed tab, e.g. "Repositories for shadyventures".

    • scopestring or null
    • installed_atstring or null
    • installed_bynull or object
      Show 2 child fields
      • idstringrequired
      • namestringrequired
    • fieldsarray of object

      Inputs needed to install. Secret values are never returned.

      Show 3 child fields
      • namestringrequired
      • labelstring
      • secretbooleanrequired
    • projectsarray of string

    Catalog with installed state

    The Integrations page: the Browse tab cards (name, description, Installed or Install) and the Installed tab rows (name, a one-line summary, scope, when it was installed, by whom).

    Permissions: Any team member. A non-member gets 404.

    GET/v1/teams/{team}/integrations
    Read or full tokenReturns200OK

    Headers

    • Authorizationstringrequired

      Bearer and your API token: Bearer orb_live_….

    Path parameters

    • teamstringrequired

      Team slug or team_ id.

    Response 200

    Catalog.
    • itemsarray of Integrationrequired
      Show 13 child fields
      • keystringrequired
      • namestringrequired
      • categorystringrequired

        One of source_code, notifications, payments, monitoring.

      • descriptionstring
      • availableboolean

        False when the integration is listed but cannot be installed yet.

      • installedbooleanrequired
      • statusstring or null

        One of connected, needs_attention.

      • summarystring or null

        One line for the Installed tab, e.g. "Repositories for shadyventures".

      • scopestring or null
      • installed_atstring or null
      • installed_bynull or object
        Show 2 child fields
        • idstringrequired
        • namestringrequired
      • fieldsarray of object

        Inputs needed to install. Secret values are never returned.

        Show 3 child fields
        • namestringrequired
        • labelstring
        • secretbooleanrequired
      • projectsarray of string

    Errors

    • 404Not found, or not visible to the caller (the two are indistinguishable on purpose).
    • 502The Git providers' state could not be read.

    Every code is explained in Errors.

    curl "https://api.theorbits.app/v1/teams/my-team/integrations" \
      -H "Authorization: Bearer $ORBITS_TOKEN"
    Response 200
    {
      "items": [
        {
          "key": "github",
          "name": "GitHub",
          "category": "source_code",
          "description": "Import repositories and deploy on every push.",
          "available": false,
          "installed": false,
          "status": "connected",
          "summary": null,
          "scope": "All projects",
          "installed_at": "2026-11-10T09:30:00Z",
          "installed_by": {
            "id": "id",
            "name": "my-app"
          },
          "fields": [
            {
              "name": "my-app",
              "label": "label",
              "secret": false
            }
          ],
          "projects": [
            "projects"
          ]
        }
      ]
    }

    Was this page helpful?

    Updated