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

# Get Workspace

> Retrieve a specific workspace by ID



## OpenAPI

````yaml GET /v1/workspaces/{id}
openapi: 3.1.0
info:
  title: Well Document API
  version: 1.0.0
  description: API for uploading and managing financial documents in the Well platform
servers:
  - url: https://api.wellapp.ai
security: []
paths:
  /v1/workspaces/{id}:
    get:
      summary: Get workspace
      description: Retrieve a specific workspace by ID
      parameters:
        - $ref: '#/components/parameters/AuthorizationHeader'
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: UUID of the workspace to retrieve
        - name: include
          in: query
          required: false
          schema:
            type: string
          description: >-
            Comma-separated list of related resources to include. Available
            options: memberships
      responses:
        '200':
          description: Workspace retrieved successfully
          content:
            application/json:
              example:
                data:
                  type: workspace
                  id: 550e8400-e29b-41d4-a716-446655440003
                  attributes:
                    name: Marketing Team Workspace
                    description: >-
                      Collaborative workspace for the marketing team to manage
                      campaigns and content
                    created_at: '2024-01-05T08:00:00Z'
                    updated_at: '2024-01-18T12:15:00Z'
                    avatar_color: '#FF5733'
                    external_workspace_id: mkt-workspace-001
                    auto_extract_enabled: false
                  relationships:
                    memberships:
                      data:
                        - type: membership
                          id: 550e8400-e29b-41d4-a716-446655440005
                        - type: membership
                          id: 550e8400-e29b-41d4-a716-446655440006
                included:
                  - type: membership
                    id: 550e8400-e29b-41d4-a716-446655440005
                    attributes:
                      role: owner
                      status: active
                  - type: memberships
                    id: 550e8400-e29b-41d4-a716-446655440006
                    attributes:
                      role: member
                      status: active
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '404':
          $ref: '#/components/responses/WorkspaceNotFound'
components:
  parameters:
    AuthorizationHeader:
      name: Authorization
      in: header
      required: true
      schema:
        type: string
      description: Bearer token for authentication
  schemas:
    WorkspaceResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              const: workspace
            id:
              type: string
              format: uuid
            attributes:
              $ref: '#/components/schemas/WorkspaceAttributes'
            relationships:
              $ref: '#/components/schemas/WorkspaceRelationshipsResponse'
            included:
              $ref: '#/components/schemas/WorkspaceIncludedipsResponse'
    UnauthorizedError:
      type: object
      properties:
        code:
          type: string
          example: UNAUTHORIZED
          description: Error code identifier
        status:
          type: integer
          example: 401
          description: HTTP status code
        title:
          type: string
          example: Unauthorized
          description: Error title
        message:
          type: string
          example: You are not authorized to access this resource
          description: Detailed error message
        meta:
          type: object
          properties:
            log_id:
              type: string
              format: uuid
              example: 65c669d4-679c-4a8b-b8c0-fbe37699bb5b
              description: Unique identifier for tracking this error in logs
          required:
            - log_id
      required:
        - code
        - status
        - title
        - message
        - meta
    WorkspaceAttributes:
      type: object
      properties:
        name:
          type: string
          description: Workspace name
        desription:
          type: string
          description: Workspace description
        external_workspace_id:
          type: string
          format: uuid
          description: external workspace id
        avatar_color:
          type: string
          format: colors
          description: Color of the avatar
        created_at:
          type: string
          format: date-time
          description: Timestamp when the workspace was created
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the workspace was last updated
    WorkspaceRelationshipsResponse:
      type: object
      properties:
        owner:
          type: object
          properties:
            data:
              type: object
              properties:
                type:
                  type: string
                id:
                  type: string
    WorkspaceIncludedipsResponse:
      type: array
      items:
        type: object
        properties:
          type:
            type: string
            const: people
            examples:
              - peoplex
          id:
            type: string
            example: temp-people1
          attributes:
            type: object
            properties:
              first_name:
                type: string
                example: John
              last_name:
                type: string
                example: Doe
              full_name:
                type: string
                example: John Doe
              created_at:
                type: string
                format: timestamp
              updated_at:
                type: string
                format: timestamp
  responses:
    WorkspaceNotFound:
      description: Workspace not found
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: string
                example: WORKSPACE_NOT_FOUND
                description: Error code identifier
              status:
                type: integer
                example: 404
                description: HTTP status code
              title:
                type: string
                example: Workspace Not Found
                description: Error title
              message:
                type: string
                example: The requested workspace could not be found
                description: Detailed error message
              meta:
                type: object
                properties:
                  log_id:
                    type: string
                    format: uuid
                    example: 65c669d4-679c-4a8b-b8c0-fbe37699bb5b
                    description: Unique identifier for tracking this error in logs
                required:
                  - log_id
            required:
              - code
              - status
              - title
              - message
              - meta

````