Skip to navigation
RESTAdminManagementSites

List Sites

Get sites linked to a headless storefront sales channels.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Channel Listingsmodifystore_channel_listings
Channel Listingsread-onlystore_channel_listings_read_only
Channel Settingsmodifystore_channel_settings
Channel Settingsread-onlystore_channel_settings_read_only
Sites & Routesmodifystore_sites
Sites & Routesread-onlystore_sites_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Query parameters

pageintegerOptional

Specifies the page number in a limited (paginated) list of items.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of items.

channel_id:inlist of integersOptional

A comma-separated list that returns sites by channel ID.

url_type:inlist of stringsOptional

A comma-separated list that returns sites by their URL type, specified in the data.urls array.

Response

A list of sites.
datalist of objectsOptional
metaobjectOptional