Get Websites

get/api/v1/websites

Request

  • Base URL: https://api.seoproai.co
  • URL: https://api.seoproai.co/api/v1/websites
  • 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)

Headers

X-User-Idstring nullable
X-Organization-Idstring nullable
Authorizationstring nullable

Response

Successful Response

namestring nullable
website_urlstring required
blog_urlstring nullable
entity_schema_enabledboolean nullable

Enable site-wide JSON-LD entity schema injection

entity_schema_typestring nullable
entity_schema_namestring nullable
entity_schema_urlstring nullable
entity_schema_same_asstring[] nullable
entity_schema_versioninteger nullable
entity_schema_created_atstring date-time nullable
entity_schema_updated_atstring date-time nullable
entity_schema_published_atstring date-time nullable
platformstring nullable
hubspot_access_tokenstring nullable
hubspot_content_group_idstring nullable
wordpress_application_urlstring nullable
wordpress_usernamestring nullable
wordpress_passwordstring nullable
wp_plugin_api_keystring nullable

API key for WordPress plugin authentication

wp_plugin_key_generated_atstring date-time nullable

When the plugin API key was generated

wp_plugin_versionstring nullable

Version of the installed WordPress plugin

wp_plugin_last_seenstring date-time nullable

Last time the plugin communicated with SEOPro AI

wp_plugin_connectedboolean nullable

Whether the WordPress plugin is connected and verified

duda_rss_api_keystring nullable
webflow_api_keystring nullable
webflow_site_idstring nullable
webflow_collection_idstring nullable
shopify_store_namestring nullable
shopify_access_tokenstring nullable
shopify_blog_idinteger nullable

Numeric Shopify blog ID

shopify_author_namestring nullable
blogger_access_tokenstring nullable
blogger_blog_idstring nullable
blogger_oauth_credentialsobject nullable
magento_base_urlstring nullable
magento_usernamestring nullable
magento_passwordstring nullable
magento_blog_pathstring nullable

Optional path prefix under which Magento CMS pages are publicly available, e.g., 'blog' or 'en/blog'

magento_store_idinteger nullable

Magento store view ID to use when creating URL rewrites (defaults to 1)

wix_site_idstring nullable
wix_api_keystring nullable
ghost_api_urlstring nullable

Ghost Admin API URL

ghost_admin_api_keystring nullable

Ghost Admin API Key

gohighlevel_location_idstring nullable
gohighlevel_access_tokenstring nullable
gohighlevel_blog_site_idstring nullable
gohighlevel_author_namestring nullable
email_notificationstring nullable
autopilotboolean
autopilot_preferencesobject nullable
company_descriptionstring nullable
unique_featuresstring[] nullable
website_analysisobject nullable
problemstring nullable
solutionstring nullable
pricingstring nullable
audiencestring nullable
blog_focusstring nullable
languagestring nullable
target_location_namestring nullable

DataForSEO location name used for keyword/SERP research, e.g. 'United Kingdom'. Null means infer from the website URL and language.

target_location_codeinteger nullable

Optional numeric DataForSEO location code. Takes precedence over target_location_name.

image_sizestring nullable

Preferred size for blog cover images, e.g., 1024x1024, 1536x1024, 1024x1536

image_prompt_instructionsstring nullable

Custom instructions for the AI image generator prompt for blog covers

image_stylestring nullable

Preferred visual style for AI-generated blog cover images

image_uniqueness_levelstring nullable

Desired variety level for generated blog cover images: balanced, distinct, or highly_distinct

brand_colorstring nullable

Primary brand color (hex or CSS color name) to influence cover images

reference_image_urlstring nullable

URL of the reference/product image stored in S3

use_uploaded_imagesboolean nullable

Use uploaded images instead of generating with AI

blog_generation_instructionsstring nullable

Custom instructions for the AI blog post generator

style_example_urlsstring[] nullable

Best article example URLs that capture the desired writing style (up to 3)

content_planner_instructionsstring nullable

Custom instructions for keyword analysis and content planning to avoid specific competitors or focus on particular topics

use_paa_questionsboolean nullable

Enable to use People Also Ask questions for topic generation

content_stylestring nullable

Content style preference: conversational, informative, or professional

youtube_channel_urlstring nullable

URL of the client's YouTube channel

include_youtube_videosboolean nullable

Automatically embed relevant YouTube videos in generated blogs

include_imagesboolean nullable

Generate AI cover and inline images for blog posts

include_additional_resourcesboolean nullable

Append Additional Resources section with external links above the CTA

max_internal_linksinteger nullable

Maximum number of internal links to add to each blog post (1-10, default: 5)

blog_word_countinteger nullable

Target word count for generated blog posts (500-5000, default: 2000)

custom_cssstring nullable

Custom CSS stylesheet to apply to generated blog posts. All HTML elements use 'seopro-' class prefix.

include_default_stylesboolean nullable

Include default inline styles in generated HTML. Set to False to use only custom CSS.

cta_stylestring nullable

Preferred CTA layout preset (e.g., minimal, spotlight, outline).

cta_card_colorstring nullable

CTA card background color (hex or CSS color keyword).

cta_button_colorstring nullable

CTA primary button color (hex or CSS color keyword).

webhook_integration_namestring nullable

Friendly name for your webhook integration

webhook_endpointstring nullable

HTTPS endpoint that will receive publish events

webhook_access_tokenstring nullable

Secret token used to authorize webhook calls

social_keywordsstring[] nullable

Keywords to monitor on social media platforms

social_subredditsstring[] nullable

Subreddits to monitor for opportunities

competitorsstring[] nullable

Competitor names to monitor

domain_ratinginteger nullable
backlink_creditsinteger nullable
monthly_backlink_limitinteger nullable
network_participationboolean nullable
backlink_summaryobject nullable
idinteger required
user_idstring required
created_atstring date-time required
updated_atstring date-time required
subscriptionobject nullable
shopify_client_idstring nullable
shopify_token_expires_atstring date-time nullable
analysis_statusstring nullable

Outcome of the last website analysis: 'complete' or 'failed'

Changes

No recorded changes to this operation across all 1 revision of this API.