--- updatedAt: 2026-06-15T22:57:17.000Z agentTools: projectIndex: https://docs.pelcro.com/llms.txt --- # Get site configuration Load your site’s public configuration before rendering customer-facing flows. ## Overview Retrieve your site’s public configuration — enabled features, products and plans, paywalls, newsletters, payment gateway settings, and design settings. Call this **first**, before rendering any customer-facing flow, so your front end knows what is available and how to behave. **Example:** On page load, fetch the site configuration to decide which paywall to show, which plans to offer, and which payment methods to display. *** ## Edge-cached for speed This endpoint is heavily edge-cached, so it typically responds in **under 80 ms**. Responses are cached for about 5 minutes. > 🚧 Configuration changes are not instant > Because of the \~5-minute cache window, a change made in the dashboard can take up to about 5 minutes to appear here. Do not rely on this endpoint for real-time state. ## Notes * **Public endpoint.** Only a valid `site_id` is required — no authentication token is needed. * The call can be made directly from a browser or front-end app. * A missing or invalid `site_id` returns a `400` response. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Open API", "version": "1.88" }, "servers": [ { "url": "https://www.pelcro.com/api/v1/sdk/" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "query", "name": "site_id" } } }, "security": [ { "sec0": [] } ], "paths": { "/site": { "get": { "summary": "Get site configuration", "description": "Load your site’s public configuration before rendering customer-facing flows.", "operationId": "api-open-get-site-configuration", "parameters": [ { "name": "site_id", "in": "query", "description": "The unique identifier of the site associated with your account.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "language", "in": "query", "required": false, "description": "Optional. Two-letter ISO 639-1 language code used to localize response messages. Supported values: en, fr, it, ko, es, de. Defaults to en; an unsupported value falls back to en.", "schema": { "type": "string", "enum": [ "en", "fr", "it", "ko", "es", "de" ], "default": "en" } } ], "responses": { "200": { "description": "Success.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean" }, "data": { "type": "object", "properties": { "account_id": { "type": "string", "nullable": true }, "security_key": { "type": "string", "nullable": true }, "ecommerce_enabled": { "type": "boolean" }, "email_verify_enabled": { "type": "boolean" }, "passwordless_enabled": { "type": "integer", "nullable": true }, "passwordless_token_duration": { "type": "integer", "nullable": true }, "auth_token_ttl_days": { "type": "integer", "nullable": true }, "google_analytics_id": { "type": "string", "nullable": true }, "google_app_id": { "type": "string", "nullable": true }, "google_app_id_ios": { "type": "string" }, "google_app_id_android": { "type": "string" }, "facebook_app_id": { "type": "string", "nullable": true }, "klaviyo_api_key": { "type": "string", "nullable": true }, "auth0_base_url": { "type": "string", "nullable": true }, "auth0_client_id": { "type": "string", "nullable": true }, "taxes_enabled": { "type": "boolean" }, "tax_inclusive": { "type": "boolean" }, "default_currency": { "type": "string", "nullable": true }, "braintree_tokenization": { "type": "string" }, "braintree_currency": { "type": "string" }, "vantiv_gateway_settings": { "type": "object", "nullable": true }, "tap_gateway_settings": { "type": "object", "nullable": true }, "cybersource_gateway_settings": { "type": "object", "nullable": true }, "braintree_gateway_settings": { "type": "object", "nullable": true }, "name": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "logo": { "type": "object", "nullable": true }, "banner_url": { "nullable": true }, "custom_css": { "type": "string", "nullable": true }, "settings": { "type": "object", "nullable": true }, "default_locale": { "type": "string", "nullable": true }, "antiadblock": { "type": "object", "nullable": true }, "products": { "type": "array", "nullable": true, "items": { "type": "object" } }, "newsletters": { "type": "array", "items": { "type": "object" } }, "restrictive_paywall_metatags_enabled": { "type": "boolean" }, "design_settings": { "type": "object", "nullable": true }, "cancel_settings": { "type": "object" }, "cancellation_reasons": { "type": "array", "items": { "type": "object" } }, "billing_settings": { "type": "object" } } } } }, "examples": { "Result": { "value": { "error": false, "data": { "account_id": "acct_1A2b3C4d5E6f7G8h", "security_key": null, "ecommerce_enabled": true, "email_verify_enabled": false, "passwordless_enabled": 0, "passwordless_token_duration": 15, "auth_token_ttl_days": 60, "google_analytics_id": null, "google_app_id": null, "google_app_id_ios": "", "google_app_id_android": "", "facebook_app_id": null, "klaviyo_api_key": null, "auth0_base_url": null, "auth0_client_id": null, "taxes_enabled": false, "tax_inclusive": false, "default_currency": "usd", "braintree_tokenization": "", "braintree_currency": "", "vantiv_gateway_settings": null, "tap_gateway_settings": null, "cybersource_gateway_settings": null, "braintree_gateway_settings": null, "name": "Example Publication", "link": "https://example.com", "slug": "example-publication", "logo": null, "banner_url": null, "custom_css": null, "settings": {}, "default_locale": "en_US", "antiadblock": null, "products": [ { "id": 1024, "address_required": true, "language": "en", "description": "Try 2 weeks free, then only $9.95 / month", "entitlements": [ "premium1" ], "name": "Premium Digital", "name_internal": "Premium Digital", "unit_label": null, "image": "https://uploads.pelcro.com/images/site/product/image/690.png", "plans": [ { "id": 1025, "product_id": 1024, "amount": 995, "amount_formatted": "$9.95", "currency": "usd", "interval": "month", "interval_count": 1, "interval_translated": "month", "auto_renew": true, "trial_period_days": 14, "nickname": "2 Week Free Trial, then $9.95/month", "description": "2 Week Free Trial, then $9.95 per month", "entitlements": [ "premium1" ], "type": "regular" } ], "paywall": { "id": 1026, "product_id": 1024, "frequency_limit": 2, "meter_title": "Subscribe today for unlimited access.", "tags": "premium1", "auto_trigger": true }, "paywalls": [] } ], "newsletters": [ { "id": 12, "title": "Daily Briefing", "subtitle": "The day in five minutes", "description": "Top stories every morning.", "photo": "https://uploads.pelcro.com/images/site/newsletter/12.png", "status": "active", "addToRegistration": true, "onlySubscribers": false } ], "restrictive_paywall_metatags_enabled": false, "design_settings": null, "cancel_settings": { "status": false, "refund": false, "countries": false, "states": false }, "cancellation_reasons": [], "billing_settings": { "vendor_tip": false } } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "examples": { "Result": { "value": { "errors": { "status": 400, "site_id": "Site ID is required" } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```