> ## 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. # List team computers > Read-only computer inventory for the current organization, including all members and shared registered devices. Includes owners, type, provider, versions, state, last contact and reported readiness. Desktops nobody has heard from for 30 days are left out and counted in `staleHidden` unless `stale=include`; a disconnected desktop stays listed for 30 days after it was disconnected. `total` and paging count what is listed, and `online` how many of those answered in the last ten minutes. Retained runner-only registrations are imported within this organization, even when stale. Registrations already pruned by runner retention cannot be recovered. `canDisconnect` and `canRemove` say what the caller may do with computers.disconnect. Devices and registered local/cloud worker instances are independently paged, 50 per page. `search` applies to both; kind/provider/availability/page filter devices; instanceDestination/instanceStatus/instanceProvider/instancePage filter registered instances. Never deployment-wide totals, credentials, files, screen content or conversation titles. Requires Devices and computers.view; does not grant control of computers. ## OpenAPI ````yaml https://api.openworklabs.com/openapi.json?public=1 get /v1/org/computers 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 ` 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 1d1e40f 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: Apps description: >- Saved reusable apps built from Workflows and Artifact 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: Controlled egress diagnostics for self-hosted deployments. - 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/org/computers: get: tags: - Devices summary: List team computers description: >- Read-only computer inventory for the current organization, including all members and shared registered devices. Includes owners, type, provider, versions, state, last contact and reported readiness. Desktops nobody has heard from for 30 days are left out and counted in `staleHidden` unless `stale=include`; a disconnected desktop stays listed for 30 days after it was disconnected. `total` and paging count what is listed, and `online` how many of those answered in the last ten minutes. Retained runner-only registrations are imported within this organization, even when stale. Registrations already pruned by runner retention cannot be recovered. `canDisconnect` and `canRemove` say what the caller may do with computers.disconnect. Devices and registered local/cloud worker instances are independently paged, 50 per page. `search` applies to both; kind/provider/availability/page filter devices; instanceDestination/instanceStatus/instanceProvider/instancePage filter registered instances. Never deployment-wide totals, credentials, files, screen content or conversation titles. Requires Devices and computers.view; does not grant control of computers. operationId: listOrganizationComputers parameters: - in: query name: search schema: type: string maxLength: 160 - in: query name: kind schema: type: string enum: - desktop - vm - in: query name: provider schema: type: string enum: - openwork_desktop - workbot - freestyle - daytona - mac_host - other - in: query name: availability schema: type: string enum: - online - paused - needs_setup - offline - unknown - in: query name: stale schema: type: string maxLength: 16 - in: query name: page schema: type: string pattern: ^[1-9]\d{0,8}$ - in: query name: instancePage schema: type: string pattern: ^[1-9]\d{0,8}$ - in: query name: instanceDestination schema: type: string enum: - local - cloud - in: query name: instanceStatus schema: type: string enum: - provisioning - healthy - failed - stopped - in: query name: instanceProvider schema: type: string maxLength: 64 responses: '200': description: Team computers returned. content: application/json: schema: type: object properties: devices: type: array items: type: object properties: id: type: string kind: type: string enum: - desktop - vm provider: type: string enum: - openwork_desktop - workbot - freestyle - daytona - mac_host - other source: type: string enum: - desktop_app - workbot - manual platform: anyOf: - type: string enum: - darwin - win32 - linux - type: 'null' label: type: string availability: type: string enum: - online - paused - needs_setup - offline - unknown state: type: string enum: - ready - paused - setup_required - unavailable - unknown statusDetail: type: - string - 'null' lastSeenAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ appVersion: type: - string - 'null' computerId: type: - string - 'null' workbotChat: type: - string - 'null' canRemove: default: false type: boolean disconnectedAt: default: null anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' canDisconnect: default: false type: boolean organization: type: object properties: id: type: string name: type: string required: - id - name owner: anyOf: - type: object properties: memberId: type: string name: type: - string - 'null' email: type: - string - 'null' former: default: false type: boolean required: - memberId - name - email - type: 'null' shared: type: boolean externalId: type: string removedAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' recentProblems: type: integer minimum: 0 maximum: 9007199254740991 lastEvent: anyOf: - type: object properties: id: type: string type: type: string enum: - registered - renamed - removed - restored - disconnected - state_changed - app_updated - computer_changed - viewer_opened - paused - resumed - rebuilt - continued - failed level: type: string enum: - info - warning - error message: type: string actor: type: string enum: - member - device - workbot - system createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ data: anyOf: - type: object propertyNames: type: string additionalProperties: type: - string - number - boolean - 'null' - type: 'null' actorId: type: - string - 'null' required: - id - type - level - message - actor - createdAt - data - actorId - type: 'null' required: - id - kind - provider - source - platform - label - availability - state - statusDetail - lastSeenAt - createdAt - appVersion - computerId - workbotChat - organization - owner - shared - externalId - removedAt - recentProblems - lastEvent total: type: integer minimum: 0 maximum: 9007199254740991 online: type: integer minimum: 0 maximum: 9007199254740991 staleHidden: default: 0 type: integer minimum: 0 maximum: 9007199254740991 page: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 pageSize: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 instances: type: array items: type: object properties: id: type: string name: type: string destination: type: string enum: - local - cloud status: type: string enum: - provisioning - healthy - failed - stopped owner: anyOf: - type: object properties: memberId: type: - string - 'null' name: type: - string - 'null' email: type: - string - 'null' required: - memberId - name - email - type: 'null' version: type: - string - 'null' provider: type: - string - 'null' region: type: - string - 'null' lastSeenAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' lastActiveAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ required: - id - name - destination - status - owner - version - provider - region - lastSeenAt - lastActiveAt - createdAt instancesTotal: type: integer minimum: 0 maximum: 9007199254740991 instancePage: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 instancePageSize: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - devices - total - page - pageSize - instances - instancesTotal - instancePage - instancePageSize '400': description: Invalid filter or id. content: application/json: schema: $ref: '#/components/schemas/InvalidRequestError' '401': description: Sign in required. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: View team computers permission required. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Computer not found, or Devices is off. content: application/json: schema: $ref: '#/components/schemas/NotFoundError' security: - denApiKey: [] - bearerAuth: [] components: schemas: InvalidRequestError: type: object properties: error: type: string const: invalid_request message: type: string details: type: array items: type: object properties: message: type: string path: type: array items: type: - string - number required: - message additionalProperties: {} capability: type: string required: - error - details UnauthorizedError: type: object properties: error: type: string const: unauthorized required: - error ForbiddenError: type: object properties: error: type: string enum: - forbidden - reauth reason: type: string message: type: string required: - error NotFoundError: type: object properties: error: type: string message: type: string 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 ` 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.