Get store public settings
curl --request GET \
--url https://api.opencals.com/storefront/stores/public-settings \
--header 'x-api-key: <api-key>'import requests
url = "https://api.opencals.com/storefront/stores/public-settings"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.opencals.com/storefront/stores/public-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opencals.com/storefront/stores/public-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.opencals.com/storefront/stores/public-settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.opencals.com/storefront/stores/public-settings")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opencals.com/storefront/stores/public-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"name": "My Store",
"domain": "my-store.opencals.com",
"externalDomain": "my-store.myshopify.com",
"currency": "USD",
"settings": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"storeId": "store-123",
"isEnabled": true,
"timezone": "UTC",
"timeFormat": "24H",
"dateFormat": "YYYY-MM-DD",
"reservationGap": 900,
"sendAppointmentConfirmationEmail": true,
"sendAppointmentReminderEmail": false,
"sendAppointmentReminderEmailTimeBefore": 3600,
"sendAppointmentFeedbackEmail": false,
"customerCalendarUrl": "https://calendar.example.com/customer",
"storefrontBaseUrl": "https://my-store.opencals.com",
"emailFromAddress": "support@example.com",
"defaultScheduleGap": "every-15-minutes",
"defaultAdvanceScheduleDays": 30,
"defaultSkipCheckout": false,
"createdAt": "2025-06-05T12:00:00Z",
"updatedAt": "2025-06-05T14:30:00Z"
},
"platform": "shopify",
"features": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"planId": "550e8400-e29b-41d4-a716-446655440000",
"feature": "staff-members-portal",
"config": "{ \"count\": 10 }"
}
],
"storefrontSettings": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"storeId": "store-123",
"themeMode": "light",
"primaryColor": "#171717",
"primaryForegroundColor": "#FAFAFA",
"secondaryColor": "#F5F5F5",
"secondaryForegroundColor": "#171717",
"destructiveColor": "#E7000B",
"accentColor": "#F5F5F5",
"accentForegroundColor": "#171717",
"backgroundColor": "#FFFFFF",
"foregroundColor": "#0A0A0A",
"cardColor": "#FFFFFF",
"cardForegroundColor": "#0A0A0A",
"popoverColor": "#FFFFFF",
"popoverForegroundColor": "#0A0A0A",
"mutedColor": "#F5F5F5",
"mutedForegroundColor": "#737373",
"borderColor": "#E5E5E5",
"inputColor": "#E5E5E5",
"ringColor": "#A1A1A1",
"sidebarColor": "#FAFAFA",
"sidebarForegroundColor": "#0A0A0A",
"sidebarPrimaryColor": "#171717",
"sidebarPrimaryForegroundColor": "#FAFAFA",
"sidebarAccentColor": "#F5F5F5",
"sidebarAccentForegroundColor": "#171717",
"sidebarBorderColor": "#E5E5E5",
"sidebarRingColor": "#A1A1A1",
"borderRadius": 0.625,
"sansSerifFont": "Inter, system-ui, sans-serif",
"serifFont": "Georgia, serif",
"monospaceFont": "JetBrains Mono, monospace",
"letterSpacing": 0,
"shadowColor": "#000000",
"shadowOpacity": 0.1,
"shadowBlurRadius": 3,
"shadowSpread": 0,
"shadowOffsetX": 0,
"shadowOffsetY": 1,
"dateFormat": "YYYY-MM-DD",
"timeFormat": "24H",
"locales": [
"en",
"pl",
"de"
],
"defaultLocale": "en",
"logoImageId": "123e4567-e89b-12d3-a456-426614174001",
"iconImageId": "123e4567-e89b-12d3-a456-426614174002",
"bannerImageId": "123e4567-e89b-12d3-a456-426614174003",
"passwordProtectionEnabled": "2025-06-05T12:00:00Z",
"password": "<string>",
"updatedAt": "2025-06-05T14:30:00Z",
"logoImage": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
},
"iconImage": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
},
"bannerImage": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
}
},
"contactInfo": {
"id": "<string>",
"storeId": "store-uuid",
"addressLine1": "123 Main Street",
"addressLine2": "Suite 100",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "United States",
"addressPlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
"latitude": 40.7128,
"longitude": -74.006,
"contactEmail": "contact@example.com",
"contactPhoneNumbers": [
"+1234567890",
"+0987654321"
],
"socialMediaLinks": [
{
"type": "instagram",
"link": "https://instagram.com/username"
},
{
"type": "custom",
"name": "My Website",
"link": "https://example.com"
}
],
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-02T00:00:00Z"
}
}Store
Get store public settings
GET
/
storefront
/
stores
/
public-settings
Get store public settings
curl --request GET \
--url https://api.opencals.com/storefront/stores/public-settings \
--header 'x-api-key: <api-key>'import requests
url = "https://api.opencals.com/storefront/stores/public-settings"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.opencals.com/storefront/stores/public-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opencals.com/storefront/stores/public-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.opencals.com/storefront/stores/public-settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.opencals.com/storefront/stores/public-settings")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opencals.com/storefront/stores/public-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"name": "My Store",
"domain": "my-store.opencals.com",
"externalDomain": "my-store.myshopify.com",
"currency": "USD",
"settings": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"storeId": "store-123",
"isEnabled": true,
"timezone": "UTC",
"timeFormat": "24H",
"dateFormat": "YYYY-MM-DD",
"reservationGap": 900,
"sendAppointmentConfirmationEmail": true,
"sendAppointmentReminderEmail": false,
"sendAppointmentReminderEmailTimeBefore": 3600,
"sendAppointmentFeedbackEmail": false,
"customerCalendarUrl": "https://calendar.example.com/customer",
"storefrontBaseUrl": "https://my-store.opencals.com",
"emailFromAddress": "support@example.com",
"defaultScheduleGap": "every-15-minutes",
"defaultAdvanceScheduleDays": 30,
"defaultSkipCheckout": false,
"createdAt": "2025-06-05T12:00:00Z",
"updatedAt": "2025-06-05T14:30:00Z"
},
"platform": "shopify",
"features": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"planId": "550e8400-e29b-41d4-a716-446655440000",
"feature": "staff-members-portal",
"config": "{ \"count\": 10 }"
}
],
"storefrontSettings": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"storeId": "store-123",
"themeMode": "light",
"primaryColor": "#171717",
"primaryForegroundColor": "#FAFAFA",
"secondaryColor": "#F5F5F5",
"secondaryForegroundColor": "#171717",
"destructiveColor": "#E7000B",
"accentColor": "#F5F5F5",
"accentForegroundColor": "#171717",
"backgroundColor": "#FFFFFF",
"foregroundColor": "#0A0A0A",
"cardColor": "#FFFFFF",
"cardForegroundColor": "#0A0A0A",
"popoverColor": "#FFFFFF",
"popoverForegroundColor": "#0A0A0A",
"mutedColor": "#F5F5F5",
"mutedForegroundColor": "#737373",
"borderColor": "#E5E5E5",
"inputColor": "#E5E5E5",
"ringColor": "#A1A1A1",
"sidebarColor": "#FAFAFA",
"sidebarForegroundColor": "#0A0A0A",
"sidebarPrimaryColor": "#171717",
"sidebarPrimaryForegroundColor": "#FAFAFA",
"sidebarAccentColor": "#F5F5F5",
"sidebarAccentForegroundColor": "#171717",
"sidebarBorderColor": "#E5E5E5",
"sidebarRingColor": "#A1A1A1",
"borderRadius": 0.625,
"sansSerifFont": "Inter, system-ui, sans-serif",
"serifFont": "Georgia, serif",
"monospaceFont": "JetBrains Mono, monospace",
"letterSpacing": 0,
"shadowColor": "#000000",
"shadowOpacity": 0.1,
"shadowBlurRadius": 3,
"shadowSpread": 0,
"shadowOffsetX": 0,
"shadowOffsetY": 1,
"dateFormat": "YYYY-MM-DD",
"timeFormat": "24H",
"locales": [
"en",
"pl",
"de"
],
"defaultLocale": "en",
"logoImageId": "123e4567-e89b-12d3-a456-426614174001",
"iconImageId": "123e4567-e89b-12d3-a456-426614174002",
"bannerImageId": "123e4567-e89b-12d3-a456-426614174003",
"passwordProtectionEnabled": "2025-06-05T12:00:00Z",
"password": "<string>",
"updatedAt": "2025-06-05T14:30:00Z",
"logoImage": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
},
"iconImage": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
},
"bannerImage": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "img_123456",
"url": "https://storage.example.com/images/product-image.jpg",
"filename": "product-image.jpg",
"mime": "image/jpeg",
"createdAt": "2023-01-01T12:00:00Z",
"updatedAt": "2023-01-02T12:00:00Z",
"deletedAt": "2023-01-03T12:00:00Z",
"storeId": "store-uuid"
}
},
"contactInfo": {
"id": "<string>",
"storeId": "store-uuid",
"addressLine1": "123 Main Street",
"addressLine2": "Suite 100",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "United States",
"addressPlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
"latitude": 40.7128,
"longitude": -74.006,
"contactEmail": "contact@example.com",
"contactPhoneNumbers": [
"+1234567890",
"+0987654321"
],
"socialMediaLinks": [
{
"type": "instagram",
"link": "https://instagram.com/username"
},
{
"type": "custom",
"name": "My Website",
"link": "https://example.com"
}
],
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-02T00:00:00Z"
}
}Authorizations
Storefront API key (sfk_...)
Response
200 - application/json
Public settings retrieved successfully
Store name
Example:
"My Store"
Store domain
Example:
"my-store.opencals.com"
Store domain (e.g., Shopify domain)
Example:
"my-store.myshopify.com"
Store currency
Example:
"USD"
Store settings
Show child attributes
Show child attributes
Store platform (e.g., Shopify)
Example:
"shopify"
Store features
Show child attributes
Show child attributes
Storefront presentation configuration
Show child attributes
Show child attributes
Store contact information
Show child attributes
Show child attributes
Last modified on July 26, 2026
Was this page helpful?
⌘I