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

# List workspaces associated with an entity



## OpenAPI

````yaml /openapi/tools-v1.yaml get /api/tools/v1/workspaces
openapi: 3.1.0
info:
  title: Govly Tools API
  version: 1.0.0
  description: >
    REST-callable tool surface for agent and automation workflows. Agents are
    the primary consumer, but integrations can be built on this API. Within this
    version, Govly aims to avoid breaking regressions in documented behavior;
    response objects may receive additional fields at any time. Responses are
    JSON for typed clients; MCP tools may render action results into
    text-oriented formats separately.
servers:
  - url: https://app.govly.com
security:
  - bearerApiKey: []
  - headerApiKey: []
tags:
  - name: Opportunities
    description: Search, fetch, and inspect Govly opportunity records.
  - name: Workspaces
    description: Create, update, and inspect opportunity workspaces.
  - name: Workspace Members
    description: Add users and teams to workspaces.
  - name: Workspace Attachments
    description: List and upload workspace attachments.
  - name: Workspace Comments
    description: Post comments to workspaces.
  - name: Follows
    description: Follow opportunities and related workspace activity.
  - name: Saved Searches
    description: List saved opportunity searches and cached matches.
  - name: Attachments
    description: Fetch extracted or readable attachment text.
paths:
  /api/tools/v1/workspaces:
    get:
      tags:
        - Workspaces
      summary: List workspaces associated with an entity
      operationId: list_workspaces
      parameters:
        - $ref: '#/components/parameters/associatedType'
        - $ref: '#/components/parameters/associatedId'
      responses:
        '200':
          description: Matching workspaces
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Workspace'
                  meta:
                    type: object
                    required:
                      - count
                    properties:
                      count:
                        type: integer
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
components:
  parameters:
    associatedType:
      name: associatedType
      in: query
      required: true
      schema:
        type: string
        enum:
          - opportunity
    associatedId:
      name: associatedId
      in: query
      required: true
      schema:
        type: string
  schemas:
    Workspace:
      type: object
      required:
        - id
        - name
        - status
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        commentsCount:
          type: integer
        status:
          type: object
          required:
            - category
            - label
          properties:
            category:
              type: string
              description: >-
                Coarse status bucket. Triage is the default for newly created
                workspaces.
            label:
              type: string
              description: >-
                Human-readable status name. Falls back to the category label
                when no custom status is set.
        primaryFocus:
          $ref: '#/components/schemas/AssociatedEntity'
        comments:
          type: array
          description: >-
            Recent comments. Only present on show/create/update responses,
            capped at the most recent 20.
          items:
            $ref: '#/components/schemas/Comment'
        attachments:
          type: array
          description: Workspace attachments. Only present on show/create/update responses.
          items:
            $ref: '#/components/schemas/WorkspaceAttachment'
    AssociatedEntity:
      type: object
      required:
        - type
        - id
      properties:
        type:
          type: string
          enum:
            - opportunity
        id:
          type: string
    Comment:
      type: object
      required:
        - id
        - body
        - createdAt
        - attachments
      properties:
        id:
          type: string
        body:
          type: string
          description: Markdown body for the comment.
        attachments:
          type: array
          description: Workspace attachments tied to this comment.
          items:
            $ref: '#/components/schemas/WorkspaceAttachment'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    WorkspaceAttachment:
      type: object
      required:
        - id
        - workspaceId
        - filename
      properties:
        id:
          type: string
        workspaceId:
          type: string
        commentId:
          type: string
          nullable: true
        filename:
          type: string
        contentType:
          type: string
        byteSize:
          type: integer
        createdAt:
          type: string
          format: date-time
        file:
          $ref: '#/components/schemas/AttachmentFile'
          description: >-
            Present only on the workspace attachments endpoint. Workspace show
            responses surface attachments without download metadata.
    ErrorEnvelope:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - status
              - code
              - title
              - detail
            properties:
              status:
                type: string
              code:
                type: string
              title:
                type: string
              detail:
                type: string
              source:
                type: object
                properties:
                  pointer:
                    type: string
    AttachmentFile:
      type: object
      description: >-
        Presigned download metadata. Omitted when the attachment is redacted or
        URLs are excluded.
      required:
        - url
        - expiresAt
      properties:
        url:
          type: string
          format: uri
        expiresAt:
          type: string
          format: date-time
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: API key
    headerApiKey:
      type: apiKey
      in: header
      name: X-API-KEY

````