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

# Get workspace by ID

> Retrieves a specific workspace by ID



## OpenAPI

````yaml /openapi/squad-api.json get /organisations/{orgId}/workspaces/{workspaceId}
openapi: 3.1.0
info:
  title: Squad API
  version: 4.8.0
  description: API for managing Squad resources
  contact:
    name: Squad Support
    url: https://www.meetsquad.ai/support
    email: help@meetsquad.ai
servers:
  - url: https://api.meetsquad.ai
    description: Production server
  - url: https://uat.api.meetsquad.ai
    description: Staging server
  - url: https://dev.api.meetsquad.ai
    description: Development server
security: []
tags:
  - name: Organisations
  - name: Workspaces
  - name: Goals
  - name: Opportunities
  - name: Solutions
  - name: Feedback
  - name: Submit Feedback
  - name: Insights
  - name: Knowledge
  - name: Metrics
  - name: Topics
  - name: Integrations
  - name: AI & Search
  - name: Onboarding
paths:
  /organisations/{orgId}/workspaces/{workspaceId}:
    get:
      tags:
        - Workspaces
      summary: Get workspace by ID
      description: Retrieves a specific workspace by ID
      operationId: getWorkspace
      parameters:
        - in: path
          name: orgId
          schema:
            type: string
          required: true
          description: Organization ID
          example: a5f3c6e1-9d20-4f7b-8e31-d09a2b63c184
        - in: path
          name: workspaceId
          schema:
            type: string
          required: true
          description: Workspace ID
          example: c0e195d9-b918-4a3a-bd8b-f730361d044f
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                description: Response containing a single workspace
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Workspace'
                    description: Workspace data
                required:
                  - data
                additionalProperties: false
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                description: Unauthorized - Missing or invalid authentication token
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        description: Error code identifier
                        example: UNAUTHORISED_ERROR
                        type: string
                      description:
                        description: Human-readable error description
                        example: User is unauthenticated
                        type: string
                    required:
                      - code
                      - description
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                description: Forbidden - Insufficient permissions to access this resource
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        description: Error code identifier
                        example: UNAUTHORISED_ERROR
                        type: string
                      description:
                        description: Human-readable error description
                        example: User is unauthorised
                        type: string
                    required:
                      - code
                      - description
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                description: Not Found - The requested resource does not exist
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        description: Error code identifier
                        example: NOT_FOUND
                        type: string
                      description:
                        description: Human-readable error description
                        example: The requested resource was not found
                        type: string
                    required:
                      - code
                      - description
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                description: >-
                  Internal Server Error - An unexpected error occurred on the
                  server
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        description: Error code identifier
                        example: INTERNAL_SERVER_ERROR
                        type: string
                      description:
                        description: Human-readable error description
                        example: An unexpected error occurred on the server
                        type: string
                    required:
                      - code
                      - description
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
      security:
        - bearerAuth: []
components:
  schemas:
    Workspace:
      description: Workspace data
      type: object
      properties:
        id:
          description: ID of the workspace
          example: c0e195d9-b918-4a3a-bd8b-f730361d044f
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        name:
          description: Name of the workspace
          example: Product Development
          type: string
        homepageUrl:
          description: URL to the workspace's homepage
          example: https://product.example.com
          type:
            - string
            - 'null'
        logoUrl:
          description: URL to the workspace's logo
          example: https://product.example.com/logo.png
          type:
            - string
            - 'null'
        missionStatement:
          description: Mission statement for the workspace
          example: Develop innovative products that solve real customer problems
          type: string
        description:
          description: Detailed description of the workspace
          example: >-
            This workspace focuses on our core product development initiatives,
            including roadmap planning, feature development, and product
            improvements.
          type: string
        createdAt:
          description: Creation timestamp
          example: '2025-03-26T22:35:46Z'
          type: string
        updatedAt:
          description: Last update timestamp
          example: '2025-03-26T22:35:46Z'
          type: string
        status:
          description: Status of the workspace
          example: Initializing
          type: string
          enum:
            - Initializing
            - OnboardingDeepResearch
            - OnboardingConsiderWorkspace
            - OnboardingConsiderOpportunities
            - OnboardingConsiderOpportunitiesToOutcomes
            - OnboardingConsiderSolutionGeneration
            - OnboardingConsiderSolutionsToBuild
            - OnboardingSelectSolutionsToBuild
            - OnboardingMapSolutionsToRoadmap
            - Active
            - Inactive
      required:
        - id
        - name
        - missionStatement
        - createdAt
        - updatedAt
        - status
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT authentication for organization-scoped endpoints.

````