Accounts and sites tools
- list_discovery_accounts: List the accounts you can access, with the environments each one supports.
- list_discovery_sites: List the sites and site groups configured for an account.
list_discovery_accounts
Lists the accounts you have access to, sorted alphabetically. Call this first when you don't know which accounts are available, or when another tool reports that several accounts exist and asks you to name one.
The response is a DiscoveryAccountsResponse object rather than a flat list of account name strings. Read each account name from data[].name, and pass that exact value as the account_name parameter to other Search tools.
Every entry also carries an environments list, so you can tell which accounts run in production, in staging, or in both before you call another tool against them. Set environment to staging to see the staging-only accounts before you start working with staging data.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
environment | str | No | Filters which accounts the list includes: production (default) or staging. The value is case-insensitive, and surrounding whitespace is trimmed. A staging-only account appears only when you filter by staging. |
Response parameters
The tool returns a DiscoveryAccountsResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | list[DiscoveryAccountInfo] | The accounts you're authorized to access. |
error | str | null | Error message if the request failed. |
The DiscoveryAccountInfo object has the following fields:
| Field | Type | Description |
|---|---|---|
name | str | The account name, for example 'your-account-1'. Pass this exact value as the account_name parameter to other Search tools. |
environments | list[str] | The environments this account supports, for example ['production'], ['production', 'staging'], or ['staging']. |
list_discovery_sites
Lists the sites configured for an account. A site represents one version of a storefront, usually a region, language, or brand within the same account. Each site carries a domain key that identifies its catalog, an optional view ID, and the site groups it belongs to.
Multi-site accounts organize storefronts in a three-level hierarchy:
- The account sits at the top.
- Site groups gather related sites, such as all English-language storefronts.
- Each site is an individual storefront version.
Rules set at a higher level flow down to everything below them. A site-level rule overrides account- and group-level rules for that site alone.
Use this tool to see which sites and site groups exist, and to retrieve the domain keys and view IDs that other Search tools need. Set account_name to target a specific account, or omit it when you have access to exactly one.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
account_name | str | null | No | The account name. Auto-selected when you have exactly one account. Use list_discovery_accounts to see available accounts. |
environment | str | No | The target environment: production (default) or staging. The value is case-insensitive, and surrounding whitespace is trimmed. Staging-only accounts always resolve to staging, regardless of this value. |
site_group_id | str | null | No | Filters results to a single site group. Omit to return all sites for the account. |
Response parameters
The tool returns a DiscoverySitesResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | list[DiscoverySite] | The sites configured for the account. |
size | int | null | The total number of sites returned. |
error | str | null | Error message if the request failed. |
environment_used | str | null | The environment actually queried: production or staging. This can differ from the environment you requested, because staging-only accounts always resolve to staging. |
The DiscoverySite object has the following fields:
| Field | Type | Description |
|---|---|---|
id | int | null | The site ID. |
name | str | null | The site's display name, for example your_domain_com 472. |
externalDomainName | str | null | The external domain name. |
viewId | str | null | The view ID for this site. Null when no view is configured. |
domainKey | str | null | The domain key identifying the catalog, for example your_domain_com. |
cmsDomainKey | str | null | The CMS domain key. |
user | str | null | The user who created or modified the site. |
createdAt | int | null | Unix timestamp in milliseconds of when the site was created. |
modifiedAt | int | null | Unix timestamp in milliseconds of when the site was last modified. |
accountId | int | null | The account ID the site belongs to. |
sitegroups | list[SiteGroupSummary] | The site groups this site belongs to. |
visible | bool | null | Whether the site is visible in the dashboard. |
The SiteGroupSummary object has the following fields:
| Field | Type | Description |
|---|---|---|
id | int | null | The site group ID. |
name | str | null | The site group name. |
createdAt | int | null | Unix timestamp in milliseconds of when the site group was created. |
modifiedAt | int | null | Unix timestamp in milliseconds of when it was last modified. |
user | str | null | The user who created or modified the site group. |
accountId | int | null | The account ID. |
userCreated | bool | null | Whether a user created the site group, rather than the system. |
merchantName | str | null | The merchant name. |
externalDomainName | str | null | The external domain name for the site group. |
Updated 9 days ago

