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

# Lister les groupes

> Renvoie tous les groupes de l’organisation avec leurs sites. Clé API globale requise. Les **intégrations partenaires** peuvent fournir `external_id` en paramètre pour trouver le groupe associé à leur identifiant. Leurs réponses incluent aussi `externalId` sur chaque groupe et chaque objet site dans `websites` (`null` sans association), pour rapprocher les sites avec votre identifiant plutôt que l’URL.



## OpenAPI

````yaml fr/api-reference/openapi.json get /api/v1/groups
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/groups:
    get:
      tags:
        - Groups
      summary: Lister les groupes
      description: >-
        Renvoie tous les groupes de l’organisation avec leurs sites. Clé API
        globale requise. Les **intégrations partenaires** peuvent fournir
        `external_id` en paramètre pour trouver le groupe associé à leur
        identifiant. Leurs réponses incluent aussi `externalId` sur chaque
        groupe et chaque objet site dans `websites` (`null` sans association),
        pour rapprocher les sites avec votre identifiant plutôt que l’URL.
      operationId: listGroups
      parameters:
        - name: external_id
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            **Partenaires uniquement.** Filtre le groupe associé à l’identifiant
            fourni. Clé partenaire requise ; client direct : `403 Forbidden`.
            Correspondance exacte dans l’organisation ; tableau vide sans
            association.
          example: acct_9e4c1b8d
      responses:
        '200':
          description: >-
            Réponse réussie avec la liste des groupes. Les réponses partenaires
            incluent `externalId` sur chaque élément (chaîne ou `null`) ; celles
            des clients directs l’omettent entièrement.
          content:
            application/json:
              schema:
                type: object
                properties:
                  groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
                required:
                  - groups
        '401':
          description: Non autorisé — clé API invalide ou absente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Interdit — clé globale requise, ou clé partenaire pour le filtre
            `external_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                global_required:
                  summary: Clé API globale requise
                  value:
                    error: 'Forbidden: global API key required'
                partner_required:
                  summary: Clé API partenaire requise pour le filtre external_id
                  value:
                    error: 'Forbidden: partner API key required'
        '500':
          description: Erreur interne du serveur
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Group:
      type: object
      description: Groupe de sites de votre organisation
      required:
        - id
        - name
        - orgId
        - billingEnabled
        - createdAt
        - websites
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique du groupe
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: Nom d’affichage du groupe
          example: Enterprise Clients
        orgId:
          type: string
          format: uuid
          description: ID de l’organisation du groupe
          example: 987e6543-e21b-12d3-a456-426614174000
        billingEnabled:
          type: boolean
          description: Indique si la facturation est activée pour ce groupe
          example: false
        createdAt:
          type: string
          format: date-time
          description: Horodatage de création du groupe (UTC)
          example: '2024-06-15T10:30:00.000Z'
        websites:
          type: array
          description: Sites web associés à ce groupe
          items:
            $ref: '#/components/schemas/GroupWebsite'
        externalId:
          type: string
          nullable: true
          description: >-
            **Partenaires uniquement.** Identifiant partenaire associé au
            groupe. Présent uniquement pour les appelants d’une organisation
            partenaire. Omis pour les clients directs. `null` indique l’absence
            d’association.
          example: acct_9e4c1b8d
    Error:
      type: object
      description: Objet de réponse d’erreur
      required:
        - error
      properties:
        error:
          type: string
          description: Message expliquant l’erreur
          example: Unauthorized
    GroupWebsite:
      type: object
      description: Site associé à un groupe
      required:
        - id
        - websiteUrl
        - websiteName
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique du site
          example: 123e4567-e89b-12d3-a456-426614174000
        websiteUrl:
          type: string
          description: URL du site
          example: example.com
        websiteName:
          type: string
          description: Nom d’affichage du site
          example: My Awesome Blog
        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
  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.