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

# Lister les workspaces



## OpenAPI

````yaml /openapi.yaml get /v1/workspaces
openapi: 3.1.0
info:
  title: Retriever Public API
  version: 1.0.0
  description: >
    API publique de Retriever : lancer l'agent de prospection (runs), lire et

    exporter des tables, importer des données, synchroniser des listes

    d'exclusion, lancer des recherches structurées (Go) et appeler des services

    atomiques.


    **Authentification** : `Authorization: Bearer ret_live_…`. Créez la clé dans

    l'application : Paramètres → **Clés API** → **Créer une clé API**. La clé
    donne accès aux ressources de

    l'organisation de son propriétaire.


    **Erreurs** : toutes les erreurs HTTP ont la forme

    `{ "error": { "code": "…", "message": "…", "details": … } }`.

    Branchez votre code sur `error.code` (stable), jamais sur `message`.


    **Limites de débit** : les réponses authentifiées par clé portent

    `RateLimit-Limit`, `RateLimit-Remaining` et `RateLimit-Reset` (secondes).

    Une réponse `429` porte aussi `Retry-After` (secondes).


    Les messages d'erreur de l'API sont en anglais.
  contact:
    name: Retriever
servers:
  - url: https://api.retriever.run
    description: Production
  - url: http://localhost:4320
    description: Serveur local
security:
  - bearerAuth: []
tags:
  - name: Runs
    description: Agent de prospection « prompt in, table out ». Asynchrone.
  - name: Tables
    description: Lecture des tables vivantes d'un workspace.
  - name: Workspaces
    description: Créer des workspaces et importer des tables.
  - name: Exclusions
    description: Listes d'entreprises et de personnes à ne jamais sourcer.
  - name: Go
    description: Recherche web autonome et extraction structurée.
  - name: Services
    description: Services atomiques (recherche, scraping, email…).
  - name: Credits
    description: Solde de crédits.
paths:
  /v1/workspaces:
    get:
      tags:
        - Workspaces
      summary: Lister les workspaces
      operationId: listWorkspaces
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Page de workspaces.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Workspace'
                  next_offset:
                    type:
                      - integer
                      - 'null'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 100
    Offset:
      name: offset
      in: query
      schema:
        type: integer
        minimum: 0
        default: 0
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        links:
          type: object
          description: Présent seulement à la création.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Code stable, à utiliser dans votre code.
            message:
              type: string
              description: Explication lisible. Peut changer.
            details:
              description: Détails optionnels (ex. liste des champs invalides).
  responses:
    Unauthorized:
      description: >-
        `not_authenticated` : header absent, mal formé (attendu `Bearer <clé>`),
        clé révoquée ou inconnue.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_authenticated
              message: A valid API key is required.
    TooManyRequests:
      description: '`rate_limited` : attendez `Retry-After` secondes puis réessayez.'
      headers:
        Retry-After:
          schema:
            type: integer
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Rate limit exceeded. Retry later.
  headers:
    RateLimit-Limit:
      schema:
        type: integer
      description: Budget de la fenêtre.
    RateLimit-Remaining:
      schema:
        type: integer
      description: Requêtes restantes.
    RateLimit-Reset:
      schema:
        type: integer
      description: Secondes avant la remise à zéro.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Clé API `ret_live_…` créée dans Settings → API keys.

````