---
title: "Get Website"
method: GET
path: "/api/v1/websites/{website_id}"
---

# Get Website

`GET /api/v1/websites/{website_id}`

## Request

- Base URL: `https://api.seoproai.co`
- URL: `https://api.seoproai.co/api/v1/websites/{website_id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://dajosjnaalanhqksxrpe.supabase.co/auth/v1/authorize`, token URL `https://dajosjnaalanhqksxrpe.supabase.co/auth/v1/token`)

## Path parameters

- `website_id` integer, required

## Headers

- `X-User-Id` string, nullable
- `X-Organization-Id` string, nullable
- `Authorization` string, nullable

## Response `200`

Successful Response

- Website
  - `name` string, nullable
  - `website_url` string, required
  - `blog_url` string, nullable
  - `entity_schema_enabled` boolean, nullable: Enable site-wide JSON-LD entity schema injection
  - `entity_schema_type` string, nullable
  - `entity_schema_name` string, nullable
  - `entity_schema_url` string, nullable
  - `entity_schema_same_as` string[], nullable
  - `entity_schema_version` integer, nullable
  - `entity_schema_created_at` string, date-time, nullable
  - `entity_schema_updated_at` string, date-time, nullable
  - `entity_schema_published_at` string, date-time, nullable
  - `platform` string, nullable
  - `hubspot_access_token` string, nullable
  - `hubspot_content_group_id` string, nullable
  - `wordpress_application_url` string, nullable
  - `wordpress_username` string, nullable
  - `wordpress_password` string, nullable
  - `wp_plugin_api_key` string, nullable: API key for WordPress plugin authentication
  - `wp_plugin_key_generated_at` string, date-time, nullable: When the plugin API key was generated
  - `wp_plugin_version` string, nullable: Version of the installed WordPress plugin
  - `wp_plugin_last_seen` string, date-time, nullable: Last time the plugin communicated with SEOPro AI
  - `wp_plugin_connected` boolean, nullable: Whether the WordPress plugin is connected and verified
  - `duda_rss_api_key` string, nullable
  - `webflow_api_key` string, nullable
  - `webflow_site_id` string, nullable
  - `webflow_collection_id` string, nullable
  - `shopify_store_name` string, nullable
  - `shopify_access_token` string, nullable
  - `shopify_blog_id` integer, nullable: Numeric Shopify blog ID
  - `shopify_author_name` string, nullable
  - `blogger_access_token` string, nullable
  - `blogger_blog_id` string, nullable
  - `blogger_oauth_credentials` object, nullable
  - `magento_base_url` string, nullable
  - `magento_username` string, nullable
  - `magento_password` string, nullable
  - `magento_blog_path` string, nullable: Optional path prefix under which Magento CMS pages are publicly available, e.g., 'blog' or 'en/blog'
  - `magento_store_id` integer, nullable: Magento store view ID to use when creating URL rewrites (defaults to 1)
  - `wix_site_id` string, nullable
  - `wix_api_key` string, nullable
  - `ghost_api_url` string, nullable: Ghost Admin API URL
  - `ghost_admin_api_key` string, nullable: Ghost Admin API Key
  - `gohighlevel_location_id` string, nullable
  - `gohighlevel_access_token` string, nullable
  - `gohighlevel_blog_site_id` string, nullable
  - `gohighlevel_author_name` string, nullable
  - `email_notification` string, nullable
  - `autopilot` boolean
  - `autopilot_preferences` object, nullable
  - `company_description` string, nullable
  - `unique_features` string[], nullable
  - `website_analysis` object, nullable
  - `problem` string, nullable
  - `solution` string, nullable
  - `pricing` string, nullable
  - `audience` string, nullable
  - `blog_focus` string, nullable
  - `language` string, nullable
  - `target_location_name` string, nullable: DataForSEO location name used for keyword/SERP research, e.g. 'United Kingdom'. Null means infer from the website URL and language.
  - `target_location_code` integer, nullable: Optional numeric DataForSEO location code. Takes precedence over target_location_name.
  - `image_size` string, nullable: Preferred size for blog cover images, e.g., 1024x1024, 1536x1024, 1024x1536
  - `image_prompt_instructions` string, nullable: Custom instructions for the AI image generator prompt for blog covers
  - `image_style` string, nullable: Preferred visual style for AI-generated blog cover images
  - `image_uniqueness_level` string, nullable: Desired variety level for generated blog cover images: balanced, distinct, or highly_distinct
  - `brand_color` string, nullable: Primary brand color (hex or CSS color name) to influence cover images
  - `reference_image_url` string, nullable: URL of the reference/product image stored in S3
  - `use_uploaded_images` boolean, nullable: Use uploaded images instead of generating with AI
  - `blog_generation_instructions` string, nullable: Custom instructions for the AI blog post generator
  - `style_example_urls` string[], nullable: Best article example URLs that capture the desired writing style (up to 3)
  - `content_planner_instructions` string, nullable: Custom instructions for keyword analysis and content planning to avoid specific competitors or focus on particular topics
  - `affiliate_links` AffiliateLink[], nullable: Affiliate links to include in generated blog posts
    - `url` string, required
    - `anchor_text` string, required
    - `placement_hint` string, nullable: Optional hint for where the link should be placed in the article
  - `use_paa_questions` boolean, nullable: Enable to use People Also Ask questions for topic generation
  - `content_style` string, nullable: Content style preference: conversational, informative, or professional
  - `youtube_channel_url` string, nullable: URL of the client's YouTube channel
  - `include_youtube_videos` boolean, nullable: Automatically embed relevant YouTube videos in generated blogs
  - `include_images` boolean, nullable: Generate AI cover and inline images for blog posts
  - `include_additional_resources` boolean, nullable: Append Additional Resources section with external links above the CTA
  - `max_internal_links` integer, nullable: Maximum number of internal links to add to each blog post (1-10, default: 5)
  - `blog_word_count` integer, nullable: Target word count for generated blog posts (500-5000, default: 2000)
  - `custom_css` string, nullable: Custom CSS stylesheet to apply to generated blog posts. All HTML elements use 'seopro-' class prefix.
  - `include_default_styles` boolean, nullable: Include default inline styles in generated HTML. Set to False to use only custom CSS.
  - `cta_style` string, nullable: Preferred CTA layout preset (e.g., minimal, spotlight, outline).
  - `cta_card_color` string, nullable: CTA card background color (hex or CSS color keyword).
  - `cta_button_color` string, nullable: CTA primary button color (hex or CSS color keyword).
  - `webhook_integration_name` string, nullable: Friendly name for your webhook integration
  - `webhook_endpoint` string, nullable: HTTPS endpoint that will receive publish events
  - `webhook_access_token` string, nullable: Secret token used to authorize webhook calls
  - `social_keywords` string[], nullable: Keywords to monitor on social media platforms
  - `social_subreddits` string[], nullable: Subreddits to monitor for opportunities
  - `competitors` string[], nullable: Competitor names to monitor
  - `domain_rating` integer, nullable
  - `backlink_credits` integer, nullable
  - `monthly_backlink_limit` integer, nullable
  - `network_participation` boolean, nullable
  - `backlink_summary` object, nullable
  - `id` integer, required
  - `user_id` string, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `subscription` object, nullable
  - `shopify_client_id` string, nullable
  - `shopify_token_expires_at` string, date-time, nullable
  - `analysis_status` string, nullable: Outcome of the last website analysis: 'complete' or 'failed'

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/seoproai/apis/seopro-ai.md) · [All operations](https://skmtc.dev/seoproai/apis/seopro-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/seoproai/apis/seopro-ai/revisions/5b4b6391ddc9?raw)