For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Carts
        • Carts
        • Channels
        • Checkouts
        • Currencies
        • Customer Segmentation
        • Geography
              • GETList Countries
              • GETGet Country
              • GETGet Count of Countries
        • Infrastructure Hosting
        • Inventory
        • Orders
        • Order Operations
        • Pickup
        • Pickup Methods
        • Pickup Options
        • Pricing
        • Price Lists
        • Promotions
        • Promotion Settings
        • Redirects
        • Scripts
        • Settings
        • Shipping
        • Sites
        • Subscribers
        • System Logs
        • Tax
        • Wishlists
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminManagementGeographyCountries

List Countries

GET
https://api.bigcommerce.com/stores/:store_hash/v2/countries
GET
/stores/:store_hash/v2/countries
$curl https://api.bigcommerce.com/stores/store_hash/v2/countries \
>     -H "Accept: application/json" \
>     -H "X-Auth-Token: <apiKey>"
200Countries_getCountries_example
1[
2  {
3    "country": "Afghanistan",
4    "country_iso2": "AF",
5    "country_iso3": "AFG",
6    "id": 1,
7    "states": {
8      "url": "https://api.bigcommerce.com/stores/store_hash/v2/countries/1/states",
9      "resource": "/countries/1/states"
10    }
11  },
12  {
13    "country": "Albania",
14    "country_iso2": "AL",
15    "country_iso3": "ALB",
16    "id": 2,
17    "states": {
18      "url": "https://api.bigcommerce.com/stores/store_hash/v2/countries/2/states",
19      "resource": "/countries/2/states"
20    }
21  }
22]
Get a list of all countries available. A country or territory, identifiable by an ISO 3166 country code.
Was this page helpful?
Previous

Geography

Next

Get Country

Built with

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

Query parameters

pagedoubleOptional
Number of pages.
limitdoubleOptional
Count per page.
countrystringOptional
country_iso2stringOptional
country_iso3stringOptional

Response

countrystring
Country name.
country_iso2string

2-letter country code.

country_iso3string

3-letter country code.

idinteger
Id of the country.
statesobject

Refers to the states object return in GET countries requests.

OAuth scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information_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.