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

# Lister les clés API

> Renvoie les clés API de l'organisation courante.



## OpenAPI

````yaml openapi.json GET /api-keys/
openapi: 3.1.0
info:
  title: Bookivox API
  version: 1.0.0
  description: >-
    API server-to-server Bookivox. Tous les chemins sont relatifs au préfixe
    `/api/v1/api`. Authentification par en-tête `X-API-Key` (l'en-tête
    `Authorization` est interdit).
servers:
  - url: https://api.bookivox.com/api/v1/api
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Clés API
    description: Créer, lister et archiver les clés API de l'organisation.
  - name: Agents
    description: Créer et piloter les agents vocaux (workflows).
  - name: Templates
    description: Partir d'un modèle d'agent prêt à l'emploi.
  - name: Chat texte
    description: Tester un agent dans une session de chat texte.
  - name: Campagnes
    description: Exécuter un agent en masse sur une liste de contacts.
  - name: Base de connaissance
    description: Gérer et interroger les documents de connaissance.
  - name: Outils
    description: Gérer les outils attachables à un nœud agent.
  - name: Crédits et usage
    description: Consulter le solde, la consommation et les statistiques.
  - name: Téléphonie
    description: >-
      Lire les configurations téléphonie et les numéros (lecture seule via clé
      API).
  - name: Node-types
    description: Catalogue des types de nœuds et de leurs propriétés.
paths:
  /api-keys/:
    get:
      tags:
        - Clés API
      summary: Lister les clés API
      description: >-
        Renvoie les clés API de l'organisation courante. La valeur en clair
        n'est jamais renvoyée : seul son préfixe (`key_prefix`) est visible.
      operationId: listApiKeys
      parameters:
        - name: include_archived
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: Inclure les clés archivées.
      responses:
        '200':
          description: Liste des clés.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    key_prefix:
                      type: string
                    is_active:
                      type: boolean
                    created_at:
                      type: string
                      format: date-time
                    last_used_at:
                      type: string
                      format: date-time
                      nullable: true
                    archived_at:
                      type: string
                      format: date-time
                      nullable: true
              example:
                - id: ak_01H...
                  name: Backend production
                  key_prefix: bcvx_ab12
                  is_active: true
                  created_at: '2025-01-15T09:30:00Z'
                  last_used_at: '2025-02-01T12:04:00Z'
                  archived_at: null
        '401':
          description: Clé API manquante ou invalide.
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Votre clé API Bookivox. Créez-la dans le dashboard, rubrique Clés API.
        L'en-tête `Authorization` est interdit sur cette surface.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.