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

# List Websites

> List websites the user can access, paginated.

Each item includes ``has_active_subscription`` so the MCP / Claude can
tell the user which sites are queryable. Sites without an active sub
are still listed (so Claude can mention them) but their data endpoints
return 403.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/websites
openapi: 3.1.0
info:
  title: Hikoo REST API
  description: >-
    Programmatic access to your Hikoo data: citations, prompts, competitors,
    audits, health and more. Authenticate with a personal API key
    (`Authorization: Bearer <key>`) created from the dashboard settings.
  version: 1.0.0
servers:
  - url: https://api.tryhikoo.com
security:
  - apiKey: []
paths:
  /api/v1/public/websites:
    get:
      tags:
        - Websites
      summary: List Websites
      description: |-
        List websites the user can access, paginated.

        Each item includes ``has_active_subscription`` so the MCP / Claude can
        tell the user which sites are queryable. Sites without an active sub
        are still listed (so Claude can mention them) but their data endpoints
        return 403.
      operationId: list_websites_api_v1_public_websites_get
      parameters:
        - name: workspace_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Filter by workspace
            title: Workspace Id
          description: Filter by workspace
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
            title: Page Size
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Bearer <api_key>
            title: Authorization
          description: Bearer <api_key>
        - name: X-MCP-Secret
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Mcp-Secret
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWebsites'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PaginatedWebsites:
      properties:
        items:
          items:
            $ref: '#/components/schemas/WebsiteListItem'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - items
        - total
        - page
        - page_size
        - total_pages
      title: PaginatedWebsites
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WebsiteListItem:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        url:
          type: string
          title: Url
        workspace_id:
          type: integer
          title: Workspace Id
        has_active_subscription:
          type: boolean
          title: Has Active Subscription
        plan_tier:
          anyOf:
            - type: string
            - type: 'null'
          title: Plan Tier
      type: object
      required:
        - id
        - name
        - url
        - workspace_id
        - has_active_subscription
      title: WebsiteListItem
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard (Settings > API keys).

````