> ## 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 sitios web

> Devuelve todos los sitios web activos asociados a tu clave de API. Las **integraciones de socios** pueden pasar `external_id` como parámetro de consulta para encontrar el sitio de Athena vinculado a su identificador.



## OpenAPI

````yaml es/api-reference/openapi.json get /api/v1/websites
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/websites:
    get:
      tags:
        - Basics
      summary: Obtener sitios web
      description: >-
        Devuelve todos los sitios web activos asociados a tu clave de API. Las
        **integraciones de socios** pueden pasar `external_id` como parámetro de
        consulta para encontrar el sitio de Athena vinculado a su identificador.
      operationId: getWebsites
      parameters:
        - name: external_id
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          description: >-
            **Solo socios.** Filtra por el sitio web vinculado a este
            identificador del socio. Solo se admite con una clave de API de
            socio; los clientes directos reciben `403 Forbidden` si lo pasan.
            Coincidencia exacta dentro de tu organización; los ID sin
            vinculación devuelven un array vacío.
          example: ws_a7f3b2c9
      responses:
        '200':
          description: >-
            Respuesta correcta con la lista de sitios web. Las respuestas a
            socios incluyen `externalId` en cada elemento (cadena o `null`); las
            respuestas a clientes directos omiten por completo el campo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  websites:
                    type: array
                    items:
                      $ref: '#/components/schemas/Website'
                required:
                  - websites
        '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: `external_id` es exclusivo para socios; las claves
            de API de otros usuarios no pueden usar este filtro.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'Forbidden: partner API key required'
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Website:
      type: object
      description: Un recurso de sitio web en AthenaHQ
      required:
        - id
        - websiteName
        - websiteUrl
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único del sitio web
          example: 123e4567-e89b-12d3-a456-426614174000
        websiteName:
          type: string
          description: Nombre visible del sitio web
          example: My Awesome Blog
        websiteUrl:
          type: string
          description: Dominio del sitio web (sin protocolo)
          example: example.com
        baseCountry:
          type: string
          nullable: true
          description: >-
            País objetivo del sitio web, definido en su perfil de marca (ajuste
            "Ubicación base"). Distingue sitios de países diferentes con una
            misma marca. Los que nunca eligieron país tienen `"United States"`
            por defecto: considéralo no confirmado si el sitio no parece
            estadounidense. Algunas filas antiguas usan códigos ISO (p. ej.,
            `"US"`) en lugar de nombres completos. Se omite por completo en
            respuestas de búsqueda con `?external_id=`.
          example: United States
        onboardingStep:
          type: integer
          nullable: true
          description: >-
            Paso actual de configuración inicial del sitio web. Null indica que
            la configuración ha terminado.
          example: null
        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
    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
  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.