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

# Répertorier les pitchs

> Renvoie tous les rapports non supprimés de l’espace de pitch de l’organisation appelante, classés par date de création décroissante. Les pitchs sont des ressources de l’organisation et ne sont pas limités à un site web.

Nécessite une **clé API globale (au niveau de l’organisation)**. Les clés limitées à certains sites sont rejetées avec `403 Forbidden`.



## OpenAPI

````yaml fr/api-reference/openapi.json get /api/v1/pitches
openapi: 3.1.0
info:
  title: API AthenaHQ
  description: >-
    L’API AthenaHQ permet de gérer vos sites et prompts par programme pour
    l’optimisation de contenu par IA.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Serveur de production
security:
  - apiKey: []
tags:
  - name: Basics
    description: Opérations API principales pour gérer sites et prompts
  - name: Metrics
    description: Points de terminaison de métriques et analyses de visibilité IA
  - name: Billing
    description: Points de facturation et crédits pour gérer la consommation
  - name: Team Management
    description: Points de terminaison de gestion des membres et invitations
  - name: Groups
    description: Points de terminaison de gestion des groupes de sites
  - name: Content
    description: >-
      Points de terminaison Content Hub : onglets, URL suivies et détail des
      prompts par URL.
  - name: Pitch Workspace
    description: >-
      Points de terminaison des rapports Pitch Workspace : exécutions à
      l’échelle de l’organisation avec concurrents, prompts, attributs et
      métriques agrégées.
  - name: Knowledge Base
    description: >-
      Endpoints de lecture de la base de connaissances de la marque — faits
      approuvés et piliers qui les organisent.
paths:
  /api/v1/pitches:
    get:
      tags:
        - Pitch Workspace
      summary: Répertorier les pitchs
      description: >-
        Renvoie tous les rapports non supprimés de l’espace de pitch de
        l’organisation appelante, classés par date de création décroissante. Les
        pitchs sont des ressources de l’organisation et ne sont pas limités à un
        site web.


        Nécessite une **clé API globale (au niveau de l’organisation)**. Les
        clés limitées à certains sites sont rejetées avec `403 Forbidden`.
      operationId: listPitches
      responses:
        '200':
          description: Réponse réussie avec la liste des propositions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  pitches:
                    type: array
                    items:
                      $ref: '#/components/schemas/PitchSummary'
                required:
                  - pitches
        '401':
          description: Non autorisé — clé API invalide ou absente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Interdit — une clé API limitée à certains sites a été utilisée. Les
            pitchs sont des ressources de l’organisation ; utilisez une clé API
            globale.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'Forbidden: global API key required'
        '500':
          description: Erreur interne du serveur.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    PitchSummary:
      type: object
      description: >-
        Rapport Pitch Workspace d’organisation, listé sans données lourdes du
        rapport.
      required:
        - id
        - company_name
        - company_url
        - company_description
        - status
        - created_at
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique de la proposition.
          example: 123e4567-e89b-12d3-a456-426614174000
        company_name:
          type: string
          description: Nom d’affichage de l’entreprise cible de la proposition.
          example: Acme Inc
        company_url:
          type: string
          description: Domaine du site de l’entreprise sans protocole.
          example: acme.com
        company_description:
          type: string
          description: >-
            Brève description de l’entreprise capturée lors de la création du
            pitch.
          example: Acme Inc sells durable industrial widgets to manufacturers.
        status:
          type: string
          enum:
            - draft
            - processing
            - completed
            - failed
          description: >-
            État de la proposition : `processing`, génération de prompts et
            réponses ; `completed`, rapport prêt ; `failed`, exécution en
            erreur.
          example: completed
        created_at:
          type: string
          format: date-time
          description: Horodatage ISO 8601 (UTC) de création du pitch.
          example: '2026-05-22T15:04:05.000Z'
        country:
          type: string
          nullable: true
          description: Pays cible de la proposition, ou `null` sans pays défini.
          example: United States
        language:
          type: string
          nullable: true
          description: Langue cible de la proposition, ou `null` sans langue définie.
          example: en
        type:
          type: string
          enum:
            - pitch_workspace
            - landing_page
          nullable: true
          description: >-
            Variante : `pitch_workspace` pour le rapport standard ;
            `landing_page` depuis une page de destination ; `null` pour les
            propositions antérieures à ce champ.
          example: pitch_workspace
    Error:
      type: object
      description: Objet de réponse d’erreur
      required:
        - error
      properties:
        error:
          type: string
          description: Message expliquant l’erreur
          example: Unauthorized
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clé API d’authentification. Créez-en une
        [ici](https://app.athenahq.ai/organization?tab=api).

````

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