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

# List workspaces

> Returns all workspaces you have access to.



## OpenAPI

````yaml /api/api_docs.yaml get /workspaces
openapi: 3.1.0
info:
  title: PeakMetrics API
  description: >
    The PeakMetrics API provides programmatic access to narrative intelligence
    data.


    Access millions of mentions across news, social media, and online platforms,
    enriched with custom AI-powered

    smart categories and over 50 metadata properties. The API enables you to

    identify, analyze, and act on emerging narratives in real-time.
  version: 2.0.0
servers:
  - url: https://api.peakmetrics.com
    description: Main (production) server
security:
  - BearerAuth: []
tags:
  - name: Authorization
  - name: Workspaces
  - name: Folders
  - name: Channels
  - name: Custom Channels
  - name: Custom Enrichments
    description: >
      Custom enrichments let you push external context about mentions into
      PeakMetrics,

      attached to individual mentions and used alongside all other mention
      metadata across

      the platform. Once written, enrichment values feed into narrative
      analysis, workspace

      summaries, and notifications, and are available through the customer API
      and the MCP

      server.


      Your team manages its own custom enrichments through the API: create one
      with

      `POST /customEnrichments`, list them with `GET /customEnrichments`, rename
      one or

      replace its option list with `PUT /customEnrichments/{enrichmentId}`,
      retire one with

      `DELETE /customEnrichments/{enrichmentId}`, and push values for individual
      mentions

      with `PUT /mentions/customEnrichments`.
paths:
  /workspaces:
    get:
      tags:
        - Workspaces
      summary: List workspaces
      description: Returns all workspaces you have access to.
      parameters:
        - in: query
          name: summary
          required: false
          schema:
            type: string
          description: >-
            If value provided is "true", summaries will be generated for each
            workspace returned. A duplicate request may be necessary to fetch
            the summaries.
      responses:
        '200':
          description: A JSON array of workspace objects
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      minimum: 1
                      description: The unique identifier for the workspace.
                    title:
                      type: string
                      description: The user entered title of the workspace.
                    owner:
                      type: string
                      description: >-
                        The unique identifier of the user who owns the
                        workspace.
                    query:
                      type: string
                      description: The query used to match mentions to the workspace.
                    channels:
                      type: array
                      items:
                        type: string
                        enum:
                          - news
                          - reddit
                          - telegram
                          - twitter
                          - youtube
                      description: >-
                        The unique identifiers of the channels that are part of
                        the workspace.
                    narrativeDetection:
                      type: object
                      properties:
                        status:
                          type: string
                          enum:
                            - new
                            - backfill
                            - active
                            - inactive
                            - error
                          description: >-
                            Whether narrative detection is enabled for the
                            workspace.
                    created:
                      type: string
                      format: date-time
                      description: The date and time the workspace was created.
                    modified:
                      type: string
                      format: date-time
                      description: The date and time the workspace was last updated.
                    folder:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: The unique folder id.
                        title:
                          type: string
                          description: The folder title.
                      description: The folder, if any, this workspace belongs to.
                    summary:
                      type: string
                      description: >-
                        The summary of the given workspace, if summary=true is
                        passed in the query string (defaults to an empty string
                        otherwise).
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````