> ## 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. # Get active organization > Returns the active organization from the current session, including its owner, the current member record, and their team memberships. ## OpenAPI ````yaml https://api.openworklabs.com/openapi.json?public=1 get /v1/org 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 7bee9d4 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: 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: 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: get: tags: - Organizations summary: Get active organization description: >- Returns the active organization from the current session, including its owner, the current member record, and their team memberships. operationId: getV1Org responses: '200': description: Organization context returned successfully. content: application/json: schema: $ref: '#/components/schemas/OrganizationContextResponse' '401': description: The caller must be signed in to load organization context. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '404': description: The organization could not be found. content: application/json: schema: $ref: '#/components/schemas/NotFoundError' security: - denApiKey: [] - bearerAuth: [] components: schemas: OrganizationContextResponse: type: object properties: organization: type: object properties: owner: anyOf: - $ref: '#/components/schemas/OrganizationOwner' - type: 'null' additionalProperties: {} currentMember: type: object properties: permissions: type: array items: type: string enum: - organization.update - branding.update - web_origins.view - web_origins.manage - invitations.manage - members.update - members.delete - teams.view - teams.manage - teams.manage_admin - permissions.view - permissions.manage - agent_permissions.view - agent_permissions.manage - sharing.manage_all - sharing.share_org_wide - sso.view - sso.manage - scim.view - scim.manage - api_keys.view - api_keys.manage - audit.view - audit.manage - egress_diagnostics.view - egress_diagnostics.manage - desktop_policies.view - desktop_policies.manage - prompts.view - prompts.manage - deployments.view - deployments.manage - billing.view - billing.manage - billing_portal.use - inference.view - inference.manage - usage_analytics.view - analytics.view - analytics.manage - llm_providers.view - llm_providers.update - llm_providers.delete - llm_provider_credentials.manage - gateway_providers.view - gateway_providers.manage - gateway_usage.view - gateway_limits.view - gateway_limits.manage - connections.view - connections.manage - connections.update - connections.disconnect - connections.delete - oauth_clients.view - oauth_clients.manage - marketplaces.manage - plugins.import - connectors.manage description: >- The caller's effective permission keys in this organization, sorted. The owner gets every key; there is no wildcard. Gate UI on these rather than on role names. Older servers omit the field. required: - permissions additionalProperties: {} currentMemberTeams: type: array items: type: object properties: {} additionalProperties: {} capabilities: type: object properties: auditLogs: type: boolean gatewayDashboard: type: boolean const: true deprecated: true description: >- Compatibility field, always true. AI Gateway is available to every organization; deployment configuration and authorization still apply. required: - auditLogs - gatewayDashboard additionalProperties: {} features: type: object properties: engineV2ForceUpgrade: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true libraryDetailBreadcrumbs: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true nativeAffordanceCodeMode: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true libraryConnectorNavigation: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true mcpAppLibraries: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true gatewayProviderTest: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true mermaidZoom: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true slackSendAsBot: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true liveProviderSync: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true browserFloatingView: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true remoteSessionSubagents: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true remoteSessionThreadView: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true remoteSessionAnswers: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true activationChecklist: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true gatewayProviderAuthErrors: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true providerCredentialStatus: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true sessionTokenHashing: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true customConnectorSetup: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true expandedMcpPresets: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true analyticsDailyTrends: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true gatewayProviderRemovalLimits: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true guidedSlackSetup: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true libraryConnectorOrgSetup: default: true deprecated: true description: >- Fixed compatibility value for supported published desktop clients; not a configurable feature. type: boolean const: true additionalProperties: type: boolean description: >- Effective on/off for every OpenWork feature in this organization, plus fixed deprecated client compatibility values. Treat a missing key as off. canManageDeploymentServices: type: boolean description: >- Whether this caller may open installation diagnostics: a self-hosted installation administrator (local allowlist), signed in or using an API key they own. Organization ownership and permissions never grant it. False on hosted deployments and when the lookup fails. deploymentCapabilities: type: object properties: version: type: number const: 1 aiGateway: type: boolean serviceReadiness: $ref: '#/components/schemas/OrganizationServiceReadiness' required: - version - aiGateway entitlements: type: object properties: sso: type: boolean desktopPolicies: type: boolean orgControls: type: boolean analytics: type: boolean auditLogs: type: boolean scim: type: boolean required: - sso - desktopPolicies - orgControls - analytics - auditLogs - scim required: - organization - currentMember - currentMemberTeams - capabilities - features - canManageDeploymentServices - deploymentCapabilities - entitlements additionalProperties: {} UnauthorizedError: type: object properties: error: type: string const: unauthorized required: - error NotFoundError: type: object properties: error: type: string message: type: string required: - error OrganizationOwner: type: object properties: memberId: description: Den TypeID with 'om_' prefix and a 26-character base32 suffix. format: typeid type: string minLength: 29 maxLength: 29 userId: description: Den TypeID with 'usr_' prefix and a 26-character base32 suffix. format: typeid type: string minLength: 30 maxLength: 30 name: type: - string - 'null' email: anyOf: - type: string format: email pattern: >- ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ - type: 'null' image: type: - string - 'null' required: - memberId - userId - name - email OrganizationServiceReadiness: type: object properties: version: type: number const: 2 checkedAt: 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))$ - type: 'null' checking: type: boolean services: maxItems: 5 type: array items: type: object properties: id: type: string enum: - database - gateway - headlessRunner - workbot - email configured: type: boolean state: type: string enum: - ready - not_configured - misconfigured - unreachable - unknown reason: type: string enum: - not_checked - not_configured - missing_configuration - invalid_configuration - health_verified - database_verified - authentication_failed - unexpected_response - request_failed - timeout - dependency_unavailable - configuration_only - incompatible_service - email_verified - email_key_verified - email_sender_unverified - resume_misconfigured dependencies: maxItems: 4 type: array items: type: string enum: - database - gateway - headlessRunner - workbot - email checkedAt: 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))$ - type: 'null' lastSuccessAt: 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))$ - type: 'null' stale: type: boolean required: - id - configured - state - reason - dependencies - checkedAt - lastSuccessAt - stale additionalProperties: false required: - version - checkedAt - checking - services additionalProperties: false 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.