Skip to main content
GET
Get Shops

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Response

200 - application/json
id
integer
Example:

1

created_at
string
Example:

"2026-11-06T10:45:19.000000Z"

updated_at
string
Example:

"2026-11-06T10:45:19.000000Z"

name
string
Example:

"Demo Shop"

subdomain
string
Example:

"demo-shop"

logo_image_id
string | null
Example:

null

favicon_image_id
string | null
Example:

null

background_image_id
string | null
Example:

null

owner_id
integer
Example:

1

description
string | null
Example:

null

currency
string
Example:

"USD"

default_language
string | null
Example:

null

enabled_languages
string | null
Example:

null

meta_title
string | null
Example:

null

meta_description
string | null
Example:

null

meta_image_id
string | null
Example:

null

meta_twitter_card
string
Example:

"summary"

discord_url
string | null
Example:

null

youtube_url
string | null
Example:

null

telegram_url
string | null
Example:

null

tiktok_url
string | null
Example:

null

instagram_url
string | null
Example:

null

theme_id
string | null
Example:

null

deleted_at
string | null
Example:

null

crisp_website_id
string | null
Example:

null

tawkto_id
string | null
Example:

null

gtag_id
string | null
Example:

null

gtm_id
string | null
Example:

null

meta_pixel_id
string | null
Example:

null

discord_client_id
string | null
Example:

null

discord_client_secret
string | null
Example:

null

discord_bot_token
string | null
Example:

null

discord_login_enabled
boolean
Example:

false

termination_reason
string | null
Example:

null

terminated_at
string | null
Example:

null

termination_appeal
string | null
Example:

null

products_sold
integer
Example:

0

products_sold_offset
integer
Example:

0

total_customers
integer
Example:

0

total_completed_invoices
string | null
Example:

null

total_customers_offset
integer
Example:

0

total_feedbacks
integer
Example:

0

average_rating
string
Example:

"0.00"

webhook_secret
string
Example:

"95eed9786f4973590ce6babe24aaffb3f77dde61216261450ce3e88170c272dd"

invoice_header
string | null
Example:

null

invoice_notes
string | null
Example:

null

Example:

null

invoice_attach_email
boolean
Example:

false

tax_enabled
boolean
Example:

false

tax_rate
string | null
Example:

null

tax_countries
string | null
Example:

null

maintenance_enabled
boolean
Example:

false

refund_out_of_stock_to_customer_balance
boolean
Example:

false

trustpilot_afs_email
string | null
Example:

null

force_custom_domain
boolean
Example:

true

hide_out_of_stock_products
boolean
Example:

false

hide_out_of_stock_variants
boolean
Example:

false

require_shipping_zone
boolean
Example:

true

noindex
boolean
Example:

false

powered_by_enabled
boolean
Example:

false

product_limit_override
string | null
Example:

null

legacy_team_limits
boolean
Example:

false

has_supplier_connections
boolean
Example:

false

has_products
boolean
Example:

true

reseller_marketplace_available
boolean
Example:

true

user_permissions
string
Example:

"*"

url
string
Example:

"http://demo-shop.mysellauth.test:80"

is_subscribed
boolean
Example:

true

subscription_ends_at
string
Example:

"2036-11-06T10:45:19.000000Z"

subscription_plan
object
subscription_source
string
Example:

"paid"

team_member_limit
integer
Example:

10

logo_image_url
string | null
Example:

null

activity_log_enabled
boolean
Example:

true

pivot
object
subscription
object
active_grant
string | null
Example:

null

theme
string | null
Example:

null

payment_methods
object[]
Example:
verified_domain
string | null
Example:

null

logo_image
string | null
Example:

null

Example: