> ## 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. # Get Website > Return the website detail (subscription, plan, settings) for the given website_id. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/public/website 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 `) created from the dashboard settings. version: 1.0.0 servers: - url: https://api.tryhikoo.com security: - apiKey: [] paths: /api/v1/public/website: get: tags: - Website summary: Get Website description: >- Return the website detail (subscription, plan, settings) for the given website_id. operationId: get_website_api_v1_public_website_get parameters: - name: website_id in: query required: true schema: type: integer description: Target website id title: Website Id description: Target website id - name: authorization in: header required: false schema: anyOf: - type: string - type: 'null' description: Bearer title: Authorization description: Bearer - 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/WebsiteResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: WebsiteResponse: properties: name: type: string title: Name url: type: string title: Url logo_url: anyOf: - type: string - type: 'null' title: Logo Url localization: type: string title: Localization default: worldwide workspace_id: type: integer title: Workspace Id id: type: integer title: Id description: anyOf: - type: string - type: 'null' title: Description analysis_status: $ref: '#/components/schemas/WebsiteAnalysisStatus' default: pending analysis_error: anyOf: - $ref: '#/components/schemas/WebsiteAnalysisError' - type: 'null' industry: anyOf: - type: string - type: 'null' title: Industry brand_identity: anyOf: - items: type: string type: array - type: 'null' title: Brand Identity topics: items: type: string type: array title: Topics competitors: items: $ref: '#/components/schemas/CompetitorWithoutLogo' type: array title: Competitors language: anyOf: - type: string - type: 'null' title: Language aliases: anyOf: - items: type: string type: array - type: 'null' title: Aliases url_aliases: anyOf: - items: type: string type: array - type: 'null' title: Url Aliases has_active_subscription: type: boolean title: Has Active Subscription default: false subscription_product_name: anyOf: - type: string - type: 'null' title: Subscription Product Name subscription_product_id: anyOf: - type: string - type: 'null' title: Subscription Product Id exports_enabled: type: boolean title: Exports Enabled default: false ai_prompt_gen_enabled: type: boolean title: Ai Prompt Gen Enabled default: true source_intelligence_enabled: type: boolean title: Source Intelligence Enabled default: true sentiment_analysis_enabled: type: boolean title: Sentiment Analysis Enabled default: true competitor_suggestions_enabled: type: boolean title: Competitor Suggestions Enabled default: true marketing_plan_enabled: type: boolean title: Marketing Plan Enabled default: false agent_analytics_enabled: type: boolean title: Agent Analytics Enabled default: false prompt_volume_enabled: type: boolean title: Prompt Volume Enabled default: false plan_tier: anyOf: - type: string - type: 'null' title: Plan Tier trial_ends_at: anyOf: - type: string format: date-time - type: 'null' title: Trial Ends At paused_at: anyOf: - type: string format: date-time - type: 'null' title: Paused At requires_post_trial_choice: type: boolean title: Requires Post Trial Choice default: false created_at: type: string format: date-time title: Created At updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At type: object required: - name - url - workspace_id - id - topics - competitors - created_at title: WebsiteResponse description: Website response schema HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError WebsiteAnalysisStatus: type: string enum: - pending - analyzing - completed - failed title: WebsiteAnalysisStatus description: |- Lifecycle of a website's onboarding analysis (crawl + LLM specs). Set to PENDING the instant the row is created (fast, synchronous), then driven by the ``website.analyze`` background job: PENDING -> ANALYZING -> COMPLETED | FAILED. WebsiteAnalysisError: type: string enum: - crawl_failed - llm_unavailable - llm_invalid_response - unknown title: WebsiteAnalysisError description: >- Stable, language-agnostic reason a website analysis failed. Stored on ``Website.analysis_error`` and surfaced to the frontend, which maps each code to a localized message. Never put human-readable / English prose in the DB for this — only these codes. CompetitorWithoutLogo: properties: id: type: integer title: Id name: type: string title: Name url: type: string title: Url aliases: anyOf: - items: type: string type: array - type: 'null' title: Aliases type: object required: - id - name - url title: CompetitorWithoutLogo description: Competitor schema without logo 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). ````