Sites

View site settings, feature flags, and capabilities.

Overview

A site represents a property (website, app) connected to your Pelcro account. Each site has its own configuration, feature flags, and capabilities that control what functionality is available.

Endpoints

MethodEndpointDescription
GET/sitesGet site

Site object

AttributeTypeDescription
idintegerUnique identifier
namestringSite name
linkstringSite URL
slugstringURL-safe slug
default_localestringDefault locale (e.g. en_US)
country_codestringCountry code
support_emailstringSupport email address
logostringLogo URL
logo_heightintegerLogo height in pixels
logo_widthintegerLogo width in pixels
banner_urlstringBanner image URL
email_notificationsbooleanEmail notifications enabled
email_verify_enabledbooleanEmail verification required
ecommerce_enabledbooleanE-commerce feature flag
apple_pay_enabledbooleanApple Pay feature flag
authenticate_single_user_enabledbooleanSingle user authentication
charge_upon_renewal_enabledbooleanCharge upon renewal
charge_upon_renewal_manual_payment_enabledbooleanManual payment on renewal
charge_upon_renewal_payment_destinationintegerRenewal payment destination
group_subscription_by_email_domain_enabledbooleanGroup subscription by email domain
group_subscription_by_ip_address_enabledbooleanGroup subscription by IP address
restrictive_paywall_metatags_enabledbooleanRestrictive paywall metatags
automatic_personal_data_deletionbooleanAutomatic personal data deletion
passwordless_enabledbooleanPasswordless login enabled
passwordless_token_durationintegerPasswordless token duration in hours
fraud_prevention_settingsobjectFraud prevention configuration
site_settingsobjectAdditional site settings
created_atintegerUnix timestamp
updated_atintegerUnix timestamp