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

# Get a workspace

> Reads one workspace and its tenant configuration. Requires an admin application key (tenant-scoped, created by an owner or admin) or a dashboard user token. Writes by a user token require an owner or admin.



## OpenAPI

````yaml /api-reference/admin-api.json get /v2/organizations/{orgId}/workspaces/{workspaceId}
openapi: 3.0.0
info:
  version: 1.0.0
  title: MinervaAI Admin API
  description: Admin endpoints for the Minerva application suite.
servers:
  - url: https://admin-api.gominerva.com
    description: The instance of admin-api to send the Swagger test requests to
security:
  - ApiKeyAuth: []
tags: []
paths:
  /v2/organizations/{orgId}/workspaces/{workspaceId}:
    get:
      tags:
        - Workspaces
      summary: Get a workspace
      description: >-
        Reads one workspace and its tenant configuration. Requires an admin
        application key (tenant-scoped, created by an owner or admin) or a
        dashboard user token. Writes by a user token require an owner or admin.
      parameters:
        - in: path
          name: orgId
          required: true
          schema:
            type: string
          description: >-
            The organization (tenant) id. Must equal the tenant of the admin
            key.
        - in: path
          name: workspaceId
          required: true
          schema:
            type: string
          description: >-
            A workspace id in this organization. A workspace of another
            organization is 404.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
        '403':
          description: >-
            No credentials were sent; the API key was revoked, has expired, or
            its application is deactivated (`API-key authentication was
            denied.`); the key is not an admin application key (standard keys
            and keys that are not application keys are refused); it belongs to
            another organization; or its creator is no longer an owner or admin.
            For a user token, the user is not a member, or is not an owner or
            admin on a write.
          content:
            text/plain:
              schema:
                type: string
        '404':
          description: >-
            The workspace or record is not in this organization, or the
            application API key (`mrva-…`) is unknown (`API-key authentication
            was denied.`).
          content:
            text/plain:
              schema:
                type: string
        '503':
          description: >-
            The authentication service is temporarily unavailable
            (`Authentication service is unavailable.`). Nothing was changed;
            retry with backoff.
          content:
            text/plain:
              schema:
                type: string
      security:
        - AdminApiKeyAuth: []
        - UserTokenAuth: []
components:
  schemas:
    WorkspaceResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: The organization id.
            workspace:
              $ref: '#/components/schemas/Workspace'
    Workspace:
      type: object
      description: >-
        A workspace and its configuration. Fields not listed here are
        configuration sections such as `matchScoring`, `automaticDisposition`,
        `riskInference`, and `clientRiskRating`.
      additionalProperties: true
      properties:
        id:
          type: string
        tenantId:
          type: string
        name:
          type: string
        isDefault:
          type: boolean
        archived:
          type: boolean
        monitoringFeedFrequencies:
          $ref: '#/components/schemas/MonitoringFeedFrequencies'
    MonitoringFeedFrequencies:
      type: object
      description: >-
        Per-feed monitoring cadence for a workspace or a risk tier. A write
        replaces the whole map: send every feed you want monitored, because a
        feed you omit is stored empty and is not monitored. `unset` is rejected
        here with 400: it is valid on profile groups only.
      additionalProperties: false
      properties:
        Sanctions:
          $ref: '#/components/schemas/MonitoringCadence'
        PEP:
          $ref: '#/components/schemas/MonitoringCadence'
        News:
          $ref: '#/components/schemas/MonitoringCadence'
        Legal:
          $ref: '#/components/schemas/MonitoringCadence'
        Criminal:
          $ref: '#/components/schemas/MonitoringCadence'
        Internal:
          $ref: '#/components/schemas/MonitoringCadence'
    MonitoringCadence:
      type: string
      description: A monitoring cadence. `deltas` is valid for Sanctions only.
      enum:
        - daily
        - weekly
        - semimonthly
        - biweekly
        - monthly
        - quarterly
        - semiannually
        - annually
        - never
        - deltas
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Admin API key for authentication. Manage API keys in the Minerva
        dashboard under Administration > Developers.
    AdminApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        An admin application key: `Authorization: Api-Key <token>` (or legacy
        `x-api-key`). Only tenant owners and admins can create one. Standard
        keys are refused with 403 on workspace management and tenant
        configuration routes.
    UserTokenAuth:
      type: apiKey
      in: header
      name: x-user-token
      description: Firebase user token for authentication

````

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