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

# Obtener grupo

> Devuelve un grupo por ID con sus sitios web asociados. Requiere una clave global. Las **integraciones de socios** reciben además `externalId` con la vinculación del socio, si existe, y cada objeto de `websites` tiene su propio `externalId` (`null` si no hay vinculación), para identificar sitios por tu identificador en lugar de por URL.



## OpenAPI

````yaml es/api-reference/openapi.json get /api/v1/groups/{group_id}
openapi: 3.1.0
info:
  title: API de AthenaHQ
  description: >-
    La API de AthenaHQ ofrece acceso programático para gestionar tus sitios web
    y consultas para optimizar el contenido con IA.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Servidor de producción
security:
  - apiKey: []
tags:
  - name: Basics
    description: Operaciones principales de la API para gestionar sitios web y consultas
  - name: Metrics
    description: Endpoints de métricas y análisis para monitorizar la visibilidad en IA
  - name: Billing
    description: Endpoints de facturación y créditos para gestionar el uso
  - name: Team Management
    description: Endpoints para gestionar miembros del equipo e invitaciones
  - name: Groups
    description: Endpoints para gestionar grupos de sitios web
  - name: Content
    description: >-
      Endpoints para acceder a los datos del centro de contenidos: pestañas, URL
      monitorizadas y desglose de consultas por URL.
  - name: Pitch Workspace
    description: >-
      Endpoints para acceder a los informes del espacio de propuestas:
      ejecuciones de propuestas con alcance de organización, con competidores,
      consultas, atributos y métricas agregadas.
  - name: Knowledge Base
    description: >-
      Endpoints para leer la base de conocimientos de la marca: datos aprobados
      sobre la marca y los pilares que los organizan.
paths:
  /api/v1/groups/{group_id}:
    parameters:
      - name: group_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: Identificador único del grupo
        example: 123e4567-e89b-12d3-a456-426614174000
    get:
      tags:
        - Groups
      summary: Obtener grupo
      description: >-
        Devuelve un grupo por ID con sus sitios web asociados. Requiere una
        clave global. Las **integraciones de socios** reciben además
        `externalId` con la vinculación del socio, si existe, y cada objeto de
        `websites` tiene su propio `externalId` (`null` si no hay vinculación),
        para identificar sitios por tu identificador en lugar de por URL.
      operationId: getGroup
      responses:
        '200':
          description: >-
            Respuesta correcta con el grupo. Las respuestas a socios incluyen
            `externalId` (cadena o `null`); las respuestas a clientes directos
            omiten por completo el campo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  group:
                    $ref: '#/components/schemas/Group'
                required:
                  - group
        '400':
          description: 'Solicitud incorrecta: formato de ID de grupo no válido'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid group ID format
        '401':
          description: 'Sin autorización: falta la clave de API o no es válida'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Acceso denegado: se requiere una clave de API global'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'Forbidden: global API key required'
        '404':
          description: 'No encontrado: el grupo no existe o no pertenece a tu organización'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Group not found
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Group:
      type: object
      description: Un grupo de sitios web de tu organización
      required:
        - id
        - name
        - orgId
        - billingEnabled
        - createdAt
        - websites
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único del grupo
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: Nombre visible del grupo
          example: Enterprise Clients
        orgId:
          type: string
          format: uuid
          description: ID de la organización a la que pertenece el grupo
          example: 987e6543-e21b-12d3-a456-426614174000
        billingEnabled:
          type: boolean
          description: Indica si la facturación está activada para este grupo
          example: false
        createdAt:
          type: string
          format: date-time
          description: Marca de tiempo de creación del grupo (UTC)
          example: '2024-06-15T10:30:00.000Z'
        websites:
          type: array
          description: Sitios web asociados a este grupo
          items:
            $ref: '#/components/schemas/GroupWebsite'
        externalId:
          type: string
          nullable: true
          description: >-
            **Solo socios.** Identificador proporcionado por el socio vinculado
            a este grupo. Solo aparece en respuestas a organizaciones marcadas
            como socios. Las respuestas a clientes directos omiten por completo
            el campo. `null` indica que no hay vinculación.
          example: acct_9e4c1b8d
    Error:
      type: object
      description: Objeto de respuesta de error
      required:
        - error
      properties:
        error:
          type: string
          description: Mensaje de error que describe qué ha fallado
          example: Unauthorized
    GroupWebsite:
      type: object
      description: Un sitio web asociado a un grupo
      required:
        - id
        - websiteUrl
        - websiteName
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único del sitio web
          example: 123e4567-e89b-12d3-a456-426614174000
        websiteUrl:
          type: string
          description: URL del sitio web
          example: example.com
        websiteName:
          type: string
          description: Nombre visible del sitio web
          example: My Awesome Blog
        externalId:
          type: string
          nullable: true
          description: >-
            **Solo socios.** Identificador proporcionado por el socio vinculado
            a este sitio web. Solo aparece en respuestas a organizaciones
            marcadas como socios. Las respuestas a clientes directos omiten por
            completo el campo. `null` indica que no hay vinculación.
          example: ws_a7f3b2c9
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clave de API para autenticarse. Puedes crear una
        [aquí](https://app.athenahq.ai/organization?tab=api).

````

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