> ## 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.

# Obtenir les sites

> Renvoie tous les sites actifs associés à la clé API. Les **intégrations partenaires** peuvent filtrer avec `external_id` pour trouver le site Athena associé à leur identifiant.



## OpenAPI

````yaml fr/api-reference/openapi.json get /api/v1/websites
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/websites:
    get:
      tags:
        - Basics
      summary: Obtenir les sites
      description: >-
        Renvoie tous les sites actifs associés à la clé API. Les **intégrations
        partenaires** peuvent filtrer avec `external_id` pour trouver le site
        Athena associé à leur identifiant.
      operationId: getWebsites
      parameters:
        - name: external_id
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            **Partenaires uniquement.** Limite au site associé à l’identifiant
            partenaire fourni. Clé API partenaire requise ; un client direct
            reçoit `403 Forbidden`. Correspondance exacte dans votre
            organisation ; un ID non associé renvoie un tableau vide.
          example: ws_a7f3b2c9
      responses:
        '200':
          description: >-
            Réponse réussie avec la liste des sites. Les réponses partenaires
            incluent `externalId` sur chaque élément (chaîne ou `null`) ; les
            réponses aux clients directs omettent entièrement ce champ.
          content:
            application/json:
              schema:
                type: object
                properties:
                  websites:
                    type: array
                    items:
                      $ref: '#/components/schemas/Website'
                required:
                  - websites
        '401':
          description: Non autorisé — clé API invalide ou absente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Interdit — `external_id` réservé aux partenaires ; les autres clés
            ne peuvent pas utiliser ce filtre.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'Forbidden: partner API key required'
        '500':
          description: Erreur interne du serveur
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Website:
      type: object
      description: Ressource de site web dans AthenaHQ
      required:
        - id
        - websiteName
        - websiteUrl
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique du site
          example: 123e4567-e89b-12d3-a456-426614174000
        websiteName:
          type: string
          description: Nom d’affichage du site
          example: My Awesome Blog
        websiteUrl:
          type: string
          description: Domaine du site web (sans protocole)
          example: example.com
        baseCountry:
          type: string
          nullable: true
          description: >-
            Pays cible défini dans le profil de marque ("Localisation de base"),
            pour distinguer les sites nationaux de même marque. Sans choix,
            `"United States"` par défaut : considérez-le non confirmé si le site
            ne semble pas américain. Quelques anciennes lignes utilisent des
            codes ISO comme `"US"`. Champ entièrement omis sur les réponses de
            recherche `?external_id=`.
          example: United States
        onboardingStep:
          type: integer
          nullable: true
          description: >-
            Étape actuelle de configuration du site. Null signifie configuration
            terminée.
          example: null
        externalId:
          type: string
          nullable: true
          description: >-
            **Partenaires uniquement.** Identifiant partenaire associé au site.
            Présent uniquement pour les organisations partenaires ; omis pour
            les clients directs. `null` sans association.
          example: ws_a7f3b2c9
    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.