> ## Documentation Index
> Fetch the complete documentation index at: https://openworklabs.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For agents: install the OpenWork desktop app with `brew install --cask openwork` (macOS) or from https://openworklabs.com/download. Do not run `npx openwork`; the npm package named `openwork` is a different project.
> Connect an agent to OpenWork with the MCP Gateway: `claude mcp add --transport http openwork https://api.openworklabs.com/mcp/agent`. Teams sign up at https://app.openworklabs.com?mode=sign-up.
> Step-by-step agent guide: https://openworklabs.com/docs/start-here/use-openwork-from-an-ai-agent.md
> Connect Slack (any organization admin): https://openworklabs.com/docs/slack/connect-slack.md. OpenWork in Slack (@openwork bot) is private alpha for approved organizations. Setup guide: https://openworklabs.com/docs/slack/overview.md. Agent skill: https://openworklabs.com/.well-known/agent-skills/set-up-openwork-slack/SKILL.md.

# The everyday apps the person can connect for Workbot

> For the Workbot app only. `connections`: the Gmail or Google Workspace, Slack and Microsoft 365 connections the organization's admins set up and this member may use, with whether each is ready for them, and where in Den they connect their own account. `apps`: every connector this member can use (shared with them org-wide, by team or directly, brought by a plugin they can use, native providers and their own sign-ins), connected or not, with a status from Den's stored credential health and readiness checks; never URLs, headers, keys or tokens. `connectors`: every connection the member may use (id, name and website host only), so Workbot can name its work in each.



## OpenAPI

````yaml https://api.openworklabs.com/openapi.json?public=1 get /v1/workbot/connections
openapi: 3.1.0
info:
  title: Den API
  description: >-
    OpenAPI spec for the Den control plane API.


    Authentication:

    - API keys (they start with `den_`) go in the `x-api-key` header as the raw
    value. Do not send them as `Authorization: Bearer`; that header only accepts
    Den session tokens, so an API key there returns 401.
      Example: `curl https://api.openworklabs.com/v1/me -H "x-api-key: den_..."`.
      API keys resolve to the issuing user and the organization member they were scoped to when created, so they can call ordinary user and organization routes without a separate signed-in session.
    - Use `Authorization: Bearer <session-token>` for user-authenticated routes
    that require a Den session.

    - Session-only flows still require a signed-in user session, including
    organization creation, invitation acceptance, active-organization switching,
    and MCP token minting.

    - Public routes like health and documentation do not require authentication.


    Swagger tip: use the security schemes in the Authorize dialog to set
    `denApiKey` (your API key) or `bearerAuth` (a session token) before trying
    protected endpoints.
  version: commit c357965
  contact:
    name: OpenWork
    url: https://openworklabs.com
    email: team@openworklabs.com
  license:
    name: OpenWork Enterprise Edition License
    url: https://github.com/different-ai/openwork/blob/dev/ee/LICENSE
servers:
  - url: https://api.openworklabs.com
security:
  - denApiKey: []
  - bearerAuth: []
tags:
  - name: System
    description: >-
      Service health, readiness, API documentation, and desktop version
      metadata.
  - name: Authentication
    description: >-
      Sign-in discovery, administrator bootstrap, OAuth provider connections,
      and MCP token minting.
  - name: OAuth
    description: >-
      OAuth 2.0 / OpenID Connect authorization-server and protected-resource
      metadata and dynamic client registration (RFC 8414, RFC 9728, RFC 7591),
      used by MCP clients.
  - name: SCIM
    description: >-
      SCIM 2.0 provisioning endpoints for identity providers (RFC 7644) and the
      organization SCIM connector management routes.
  - name: SSO
    description: Organization single sign-on connector management routes.
  - name: Bootstrap
    description: Agent-first provisional workspace setup routes.
  - name: Users
    description: Current user and membership routes.
  - name: Organizations
    description: Organization creation, context, brand assets, and install links.
  - name: Invitations
    description: Invitation preview, acceptance, creation, and cancellation routes.
  - name: Sandbox organizations
    description: Preview and join a sandbox organization with its shareable join link.
  - name: Members
    description: Organization member management routes.
  - name: Teams
    description: Organization team management routes.
  - name: Permissions
    description: >-
      Organization permissions: the permission catalog, Member, Admin and team
      permission sets, their history, and each member's effective permissions.
  - name: API Keys
    description: Organization API key management routes.
  - name: Desktop Policies
    description: Desktop app policies applied to the organization, members, or teams.
  - name: Config blobs
    description: >-
      Export the organization's configuration as JSON and import it through
      reviewed change requests: plan, decisions, secret inputs, approval, apply
      and revert.
  - name: Agent Permissions
    description: What agents may do on members' computers, set for everyone and per team.
  - name: LLM Providers
    description: Organization LLM provider catalog, configuration, and access routes.
  - name: Inference
    description: Organization inference settings.
  - name: Inference Providers
    description: >-
      Organization inference Gateway providers, model groups, credential sets,
      access grants, member connections, and usage.
  - name: Gateway Usage Limits
    description: >-
      Estimated-cost policies, independent member calendar buckets, assignments,
      and audited usage-extension requests.
  - name: Cloud
    description: Organization Cloud instance lifecycle and browser gateway resolution.
  - name: Workers
    description: >-
      List and delete the organization's workers, including OpenWork Web
      instances.
  - name: Worker Activity
    description: Worker heartbeat and activity reporting routes.
  - name: Managed deployments
    description: >-
      OpenWork installations in an organization's own cloud account: launch
      approval, installer milestones and health reports.
  - name: Automations
    description: Scheduled Automations, their runs, and desktop runner presence.
  - name: Devices
    description: >-
      Personal and shared computers, plus permission-gated team computer
      inventory for the current organization, including registered OpenWork
      instances. Inventory grants no control or access to private content.
  - name: Documents
    description: >-
      Connected Drive documents, inline editing and file-bound temporary Office
      sessions.
  - name: Workbot
    description: The signed-in member's single Workbot conversation.
  - name: Workflows
    description: Saved Workflows (Code Mode scripts), their versions, snapshots, and views.
  - name: Workflow Runs
    description: Durable Workflow run history.
  - name: Codemode Runs
    description: Generated Artifact views produced by Code Mode runs.
  - name: Artifacts
    description: >-
      Reusable interactive views, including saved Workflow views, and their
      sharing.
  - name: Config Objects
    description: >-
      Versioned configuration objects (skills, workflows, and other plugin
      content).
  - name: Plugins
    description: Plugin packages, access grants, and imports.
  - name: Marketplaces
    description: Marketplaces that distribute plugins to members and teams.
  - name: Resources
    description: >-
      Aggregated snapshot of the resources and marketplace capabilities
      available to the caller.
  - name: Capability Sources
    description: >-
      Native provider capabilities (Google Workspace, Microsoft 365) and
      external MCP connections executed as the calling member.
  - name: Direct uploads
    description: Multipart uploads that stream workspace files straight to a provider.
  - name: Connectors
    description: >-
      Connector accounts and instances (GitHub and other sources) and their sync
      state.
  - name: GitHub
    description: >-
      GitHub App installation, repository discovery, and plugin import from
      GitHub.
  - name: Diagnostics
    description: >-
      Settings › Diagnostics: desktop app startups, model providers, connectors
      and installation services.
  - name: Telemetry
    description: Telemetry event ingestion and adoption analytics.
  - name: Webhooks
    description: Signed inbound webhooks from third-party providers.
  - name: Admin
    description: Platform administration routes for allowlisted OpenWork administrators.
  - name: Deprecated
    description: Removed features that answer with 410 or an empty result for old clients.
paths:
  /v1/workbot/connections:
    get:
      tags:
        - Workbot
      summary: The everyday apps the person can connect for Workbot
      description: >-
        For the Workbot app only. `connections`: the Gmail or Google Workspace,
        Slack and Microsoft 365 connections the organization's admins set up and
        this member may use, with whether each is ready for them, and where in
        Den they connect their own account. `apps`: every connector this member
        can use (shared with them org-wide, by team or directly, brought by a
        plugin they can use, native providers and their own sign-ins), connected
        or not, with a status from Den's stored credential health and readiness
        checks; never URLs, headers, keys or tokens. `connectors`: every
        connection the member may use (id, name and website host only), so
        Workbot can name its work in each.
      operationId: listWorkbotConnections
      responses:
        '200':
          description: The connections.
          content:
            application/json:
              schema:
                type: object
                properties:
                  connections:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        app:
                          type: string
                          enum:
                            - gmail
                            - googleCalendar
                            - slack
                            - microsoft
                        ready:
                          type: boolean
                        connectUrl:
                          type:
                            - string
                            - 'null'
                        nativeProviderKey:
                          type:
                            - string
                            - 'null'
                        connectMode:
                          type: string
                          enum:
                            - inline
                            - external
                            - admin
                      required:
                        - id
                        - name
                        - app
                        - ready
                        - connectUrl
                  apps:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        iconCandidates:
                          type: array
                          items:
                            type: string
                        nativeProviderKey:
                          type:
                            - string
                            - 'null'
                        authType:
                          type: string
                          enum:
                            - oauth
                            - apikey
                            - none
                        status:
                          type: string
                          enum:
                            - connected
                            - needs_sign_in
                            - not_connected
                            - needs_attention
                        managedBy:
                          type: string
                          enum:
                            - you
                            - organization
                        action:
                          anyOf:
                            - type: string
                              enum:
                                - connect
                                - ask_admin
                                - admin_settings
                            - type: 'null'
                        connectMode:
                          type: string
                          enum:
                            - inline
                            - external
                            - admin
                        connectUrl:
                          type:
                            - string
                            - 'null'
                        ready:
                          type: boolean
                      required:
                        - id
                        - name
                        - nativeProviderKey
                        - authType
                        - status
                        - managedBy
                        - action
                        - connectMode
                        - connectUrl
                        - ready
                  connectors:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        site:
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - name
                        - site
                required:
                  - connections
                  - connectors
        '401':
          description: The token is missing, expired or revoked, or the membership ended.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Workbot is off for the member.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                required:
                  - error
      security:
        - denApiKey: []
        - bearerAuth: []
components:
  schemas:
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          const: unauthorized
      required:
        - error
  securitySchemes:
    denApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organization API key passed as the `x-api-key` header. The raw key is
        the header value; do not prefix it with `Bearer`.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: session-token
      description: >-
        Den session token passed as `Authorization: Bearer <session-token>` for
        user-authenticated Den routes. Not for API keys: send `den_` keys in the
        `x-api-key` header instead.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.