> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List countries for first-run setup

> Countries the store can be set up in, each with the currency and
official languages derived from it. Unauthenticated, because the setup
screen runs before any credential exists. Returns 404 once any admin
user exists.




## OpenAPI

````yaml /api-reference/admin.yaml get /api/v3/admin/auth/setup/countries
openapi: 3.0.3
info:
  title: Admin API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Admin API v3 - Administrative API for managing products, orders, and
    store settings.


    ## Authentication


    The Admin API requires a secret API key passed in the `x-spree-api-key`
    header.

    Secret API keys can be generated in the Spree admin dashboard.


    ## Response Format


    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    Single resource endpoints return a flat JSON object.


    ## Resource IDs


    Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,

    `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,

    request bodies, and Ransack filters all accept them directly.


    ## Error Handling


    Errors return a consistent format:

    ```json

    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }

    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Admin user login, logout, token refresh, and current user profile
  - name: Allowed Origins
    description: CORS allowlist for storefront and admin client origins
  - name: API Keys
    description: Secret and publishable API keys
  - name: Categories
    description: >-
      Hierarchical product categories — tree management, repositioning, and
      product assignments
  - name: Channels
    description: >-
      Sales channels, product publication across channels, and per-channel order
      routing rules
  - name: Custom Fields
    description: >-
      Custom field definitions for products, variants, customers, and other
      resources
  - name: Customer Groups
    description: >-
      Customer groups for segmenting customers (e.g. wholesale, VIP) used by
      pricing and promotions
  - name: Customers
    description: Customer profiles, addresses, credit cards, and store credits
  - name: Email Templates
    description: >-
      Customer email templates, the email layout and shared partials: drafts,
      previews, publishing and history
  - name: Exports
    description: Async CSV exports of admin resources
  - name: Files
    description: Uploading the files that product media, imports, logos and documents use
  - name: Fulfillments
    description: Order fulfillments — shipments, fulfill, cancel, resume, split
  - name: Gift Cards
    description: Gift cards and gift card batches
  - name: Imports
    description: >-
      Async CSV imports of admin resources, with per-row status and failed-row
      retry
  - name: Maintenance Tasks
    description: >-
      Operator-run data work — backfills, reindexes and upgrade steps — and the
      record of every run
  - name: Markets
    description: >-
      Markets — geographic groupings of countries used for pricing, tax, and
      fulfillment rules
  - name: Option Types
    description: >-
      Option types and option values used to build product variants (e.g. Size,
      Color)
  - name: Orders
    description: Orders, order items, applied gift cards, and applied store credits
  - name: Payment Methods
    description: Configured payment providers and their available types
  - name: Payments
    description: Order payments — list, capture, void
  - name: Pricing
    description: >-
      Prices and price lists for currency-, market-, and customer-group-specific
      pricing
  - name: Products
    description: >-
      Products, taxons/categories, product custom field values, and bulk product
      operations
  - name: Policies
    description: The store's legal documents — terms of service, privacy, returns, shipping
  - name: Reasons
    description: >-
      Merchant-owned vocabularies for why a return, claim, refund, cancellation
      or tax exemption happened
  - name: Promotions
    description: Promotions, promotion rules, promotion actions, and coupon codes
  - name: Refunds
    description: Order refunds
  - name: Settings
    description: Store-level settings — store profile, tags, and configuration
  - name: Staff
    description: Admin users, roles, and invitations to the store
  - name: Stock Locations
    description: Warehouses and physical fulfillment locations
  - name: Store Credits
    description: Prepaid customer balances across all customers, and each balance's ledger
  - name: Variants
    description: >-
      Product variants — the individual SKUs (size/color combinations) sold
      under a product
  - name: Webhooks
    description: Webhook endpoints and webhook delivery history
paths:
  /api/v3/admin/auth/setup/countries:
    get:
      tags:
        - Authentication
      summary: List countries for first-run setup
      description: |
        Countries the store can be set up in, each with the currency and
        official languages derived from it. Unauthenticated, because the setup
        screen runs before any credential exists. Returns 404 once any admin
        user exists.
      responses:
        '200':
          description: countries
          content:
            application/json:
              example:
                countries:
                  - code: AD
                    currency: EUR
                    locales:
                      - ca
                  - code: AE
                    currency: AED
                    locales:
                      - ar
                  - code: AF
                    currency: AFN
                    locales:
                      - ps
                      - uz
                      - tk
                  - code: AG
                    currency: XCD
                    locales:
                      - en
                  - code: AI
                    currency: XCD
                    locales:
                      - en
                  - code: AL
                    currency: ALL
                    locales:
                      - sq
                  - code: AM
                    currency: AMD
                    locales:
                      - hy
                  - code: AO
                    currency: AOA
                    locales:
                      - pt
                  - code: AR
                    currency: ARS
                    locales:
                      - es
                      - gn
                  - code: AS
                    currency: USD
                    locales:
                      - en
                      - sm
                  - code: AT
                    currency: EUR
                    locales:
                      - de
                  - code: AU
                    currency: AUD
                    locales:
                      - en
                  - code: AW
                    currency: AWG
                    locales:
                      - nl
                  - code: AZ
                    currency: AZN
                    locales:
                      - az
                      - hy
                  - code: BA
                    currency: BAM
                    locales:
                      - bs
                      - hr
                      - sr
                  - code: BB
                    currency: BBD
                    locales:
                      - en
                  - code: BD
                    currency: BDT
                    locales:
                      - bn
                  - code: BE
                    currency: EUR
                    locales:
                      - nl
                      - fr
                      - de
                  - code: BF
                    currency: XOF
                    locales:
                      - fr
                      - ff
                  - code: BG
                    currency: EUR
                    locales:
                      - bg
                  - code: BH
                    currency: BHD
                    locales:
                      - ar
                  - code: BI
                    currency: BIF
                    locales:
                      - fr
                      - rn
                  - code: BJ
                    currency: XOF
                    locales:
                      - fr
                  - code: BL
                    currency: EUR
                    locales:
                      - fr
                  - code: BM
                    currency: BMD
                    locales:
                      - en
                  - code: BN
                    currency: BND
                    locales:
                      - ms
                  - code: BO
                    currency: BOB
                    locales:
                      - es
                      - ay
                      - qu
                  - code: BQ
                    currency: USD
                    locales:
                      - nl
                      - en
                  - code: BR
                    currency: BRL
                    locales:
                      - pt
                  - code: BS
                    currency: BSD
                    locales:
                      - en
                  - code: BT
                    currency: BTN
                    locales:
                      - dz
                  - code: BW
                    currency: BWP
                    locales:
                      - en
                      - tn
                  - code: BY
                    currency: BYN
                    locales:
                      - be
                      - ru
                  - code: BZ
                    currency: BZD
                    locales:
                      - en
                      - es
                  - code: CA
                    currency: CAD
                    locales:
                      - en
                      - fr
                  - code: CC
                    currency: AUD
                    locales:
                      - en
                  - code: CD
                    currency: CDF
                    locales:
                      - fr
                      - ln
                      - kg
                      - sw
                      - lu
                  - code: CF
                    currency: XAF
                    locales:
                      - fr
                      - sg
                  - code: CG
                    currency: XAF
                    locales:
                      - fr
                      - ln
                  - code: CH
                    currency: CHF
                    locales:
                      - de
                      - fr
                      - it
                      - rm
                  - code: CI
                    currency: XOF
                    locales:
                      - fr
                  - code: CK
                    currency: NZD
                    locales:
                      - en
                  - code: CL
                    currency: CLP
                    locales:
                      - es
                  - code: CM
                    currency: XAF
                    locales:
                      - en
                      - fr
                  - code: CN
                    currency: CNY
                    locales:
                      - zh-CN
                  - code: CO
                    currency: COP
                    locales:
                      - es
                  - code: CR
                    currency: CRC
                    locales:
                      - es
                  - code: CU
                    currency: CUP
                    locales:
                      - es
                  - code: CV
                    currency: CVE
                    locales:
                      - pt
                  - code: CW
                    currency: XCG
                    locales:
                      - nl
                  - code: CX
                    currency: AUD
                    locales:
                      - en
                      - zh-CN
                      - ms
                  - code: CY
                    currency: EUR
                    locales:
                      - el
                      - tr
                      - hy
                  - code: CZ
                    currency: CZK
                    locales:
                      - cs
                  - code: DE
                    currency: EUR
                    locales:
                      - de
                  - code: DJ
                    currency: DJF
                    locales:
                      - ar
                      - fr
                  - code: DK
                    currency: DKK
                    locales:
                      - da
                  - code: DM
                    currency: XCD
                    locales:
                      - en
                  - code: DO
                    currency: DOP
                    locales:
                      - es
                  - code: DZ
                    currency: DZD
                    locales:
                      - ar
                  - code: EC
                    currency: USD
                    locales:
                      - es
                  - code: EE
                    currency: EUR
                    locales:
                      - et
                  - code: EG
                    currency: EGP
                    locales:
                      - ar
                  - code: ER
                    currency: ERN
                    locales:
                      - en
                      - ar
                      - ti
                  - code: ES
                    currency: EUR
                    locales:
                      - es
                  - code: ET
                    currency: ETB
                    locales:
                      - am
                  - code: FI
                    currency: EUR
                    locales:
                      - fi
                      - sv
                  - code: FJ
                    currency: FJD
                    locales:
                      - en
                      - fj
                      - hi
                  - code: FK
                    currency: FKP
                    locales:
                      - en
                  - code: FM
                    currency: USD
                    locales:
                      - en
                  - code: FO
                    currency: DKK
                    locales:
                      - fo
                  - code: FR
                    currency: EUR
                    locales:
                      - fr
                  - code: GA
                    currency: XAF
                    locales:
                      - fr
                  - code: GB
                    currency: GBP
                    locales:
                      - en
                  - code: GD
                    currency: XCD
                    locales:
                      - en
                  - code: GE
                    currency: GEL
                    locales:
                      - ka
                  - code: GF
                    currency: EUR
                    locales:
                      - fr
                  - code: GG
                    currency: GBP
                    locales:
                      - en
                      - fr
                  - code: GH
                    currency: GHS
                    locales:
                      - en
                  - code: GI
                    currency: GIP
                    locales:
                      - en
                  - code: GL
                    currency: DKK
                    locales:
                      - kl
                  - code: GM
                    currency: GMD
                    locales:
                      - en
                  - code: GN
                    currency: GNF
                    locales:
                      - fr
                      - ff
                  - code: GP
                    currency: EUR
                    locales:
                      - fr
                  - code: GQ
                    currency: XAF
                    locales:
                      - es
                      - fr
                  - code: GR
                    currency: EUR
                    locales:
                      - el
                  - code: GT
                    currency: GTQ
                    locales:
                      - es
                  - code: GU
                    currency: USD
                    locales:
                      - en
                      - ch
                      - es
                  - code: GW
                    currency: XOF
                    locales:
                      - pt
                  - code: GY
                    currency: GYD
                    locales:
                      - en
                  - code: HK
                    currency: HKD
                    locales:
                      - en
                      - zh-CN
                  - code: HN
                    currency: HNL
                    locales:
                      - es
                  - code: HR
                    currency: EUR
                    locales:
                      - hr
                  - code: HT
                    currency: HTG
                    locales:
                      - fr
                      - ht
                  - code: HU
                    currency: HUF
                    locales:
                      - hu
                  - code: ID
                    currency: IDR
                    locales:
                      - id
                  - code: IE
                    currency: EUR
                    locales:
                      - en
                      - ga
                  - code: IL
                    currency: ILS
                    locales:
                      - he
                      - ar
                  - code: IM
                    currency: GBP
                    locales:
                      - en
                      - gv
                  - code: IN
                    currency: INR
                    locales:
                      - hi
                      - en
                  - code: IQ
                    currency: IQD
                    locales:
                      - ar
                  - code: IR
                    currency: IRR
                    locales:
                      - fa
                  - code: IS
                    currency: ISK
                    locales:
                      - is
                  - code: IT
                    currency: EUR
                    locales:
                      - it
                  - code: JE
                    currency: GBP
                    locales:
                      - en
                      - fr
                  - code: JM
                    currency: JMD
                    locales:
                      - en
                  - code: JO
                    currency: JOD
                    locales:
                      - ar
                  - code: JP
                    currency: JPY
                    locales:
                      - ja
                  - code: KE
                    currency: KES
                    locales:
                      - en
                      - sw
                  - code: KG
                    currency: KGS
                    locales:
                      - ky
                      - ru
                  - code: KH
                    currency: KHR
                    locales:
                      - km
                  - code: KI
                    currency: AUD
                    locales:
                      - en
                  - code: KM
                    currency: KMF
                    locales:
                      - ar
                      - fr
                  - code: KN
                    currency: XCD
                    locales:
                      - en
                  - code: KP
                    currency: KPW
                    locales:
                      - ko
                  - code: KR
                    currency: KRW
                    locales:
                      - ko
                  - code: KW
                    currency: KWD
                    locales:
                      - ar
                  - code: KY
                    currency: KYD
                    locales:
                      - en
                  - code: KZ
                    currency: KZT
                    locales:
                      - kk
                      - ru
                  - code: LA
                    currency: LAK
                    locales:
                      - lo
                  - code: LB
                    currency: LBP
                    locales:
                      - ar
                      - fr
                  - code: LC
                    currency: XCD
                    locales:
                      - en
                  - code: LI
                    currency: CHF
                    locales:
                      - de
                  - code: LK
                    currency: LKR
                    locales:
                      - si
                      - ta
                  - code: LR
                    currency: LRD
                    locales:
                      - en
                  - code: LS
                    currency: LSL
                    locales:
                      - en
                      - st
                  - code: LT
                    currency: EUR
                    locales:
                      - lt
                  - code: LU
                    currency: EUR
                    locales:
                      - fr
                      - de
                      - lb
                  - code: LV
                    currency: EUR
                    locales:
                      - lv
                  - code: LY
                    currency: LYD
                    locales:
                      - ar
                  - code: MA
                    currency: MAD
                    locales:
                      - ar
                  - code: MC
                    currency: EUR
                    locales:
                      - fr
                  - code: MD
                    currency: MDL
                    locales:
                      - ro
                  - code: ME
                    currency: EUR
                    locales:
                      - sr
                      - bs
                      - sq
                      - hr
                  - code: MF
                    currency: EUR
                    locales:
                      - en
                      - fr
                      - nl
                  - code: MG
                    currency: MGA
                    locales:
                      - fr
                      - mg
                  - code: MH
                    currency: USD
                    locales:
                      - en
                      - mh
                  - code: MK
                    currency: MKD
                    locales:
                      - mk
                  - code: ML
                    currency: XOF
                    locales:
                      - fr
                  - code: MM
                    currency: MMK
                    locales:
                      - my
                  - code: MN
                    currency: MNT
                    locales:
                      - mn
                  - code: MO
                    currency: MOP
                    locales:
                      - zh-CN
                      - pt
                  - code: MP
                    currency: USD
                    locales:
                      - en
                      - ch
                  - code: MQ
                    currency: EUR
                    locales:
                      - fr
                  - code: MR
                    currency: MRU
                    locales:
                      - ar
                      - fr
                  - code: MS
                    currency: XCD
                    locales:
                      - en
                  - code: MT
                    currency: EUR
                    locales:
                      - mt
                      - en
                  - code: MU
                    currency: MUR
                    locales:
                      - en
                  - code: MV
                    currency: MVR
                    locales:
                      - dv
                  - code: MW
                    currency: MWK
                    locales:
                      - en
                      - ny
                  - code: MX
                    currency: MXN
                    locales:
                      - es
                  - code: MY
                    currency: MYR
                    locales:
                      - ms
                      - en
                  - code: MZ
                    currency: MZN
                    locales:
                      - pt
                  - code: NA
                    currency: NAD
                    locales:
                      - en
                      - af
                  - code: NC
                    currency: XPF
                    locales:
                      - fr
                  - code: NE
                    currency: XOF
                    locales:
                      - fr
                  - code: NF
                    currency: AUD
                    locales:
                      - en
                  - code: NG
                    currency: NGN
                    locales:
                      - en
                  - code: NI
                    currency: NIO
                    locales:
                      - es
                  - code: NL
                    currency: EUR
                    locales:
                      - nl
                  - code: 'NO'
                    currency: NOK
                    locales:
                      - nb
                      - nn
                  - code: NP
                    currency: NPR
                    locales:
                      - ne
                  - code: NR
                    currency: AUD
                    locales:
                      - en
                      - na
                  - code: NU
                    currency: NZD
                    locales:
                      - en
                  - code: NZ
                    currency: NZD
                    locales:
                      - en
                  - code: OM
                    currency: OMR
                    locales:
                      - ar
                  - code: PA
                    currency: PAB
                    locales:
                      - es
                  - code: PE
                    currency: PEN
                    locales:
                      - es
                  - code: PF
                    currency: XPF
                    locales:
                      - fr
                  - code: PG
                    currency: PGK
                    locales:
                      - en
                  - code: PH
                    currency: PHP
                    locales:
                      - tl
                      - en
                  - code: PK
                    currency: PKR
                    locales:
                      - en
                      - ur
                  - code: PL
                    currency: PLN
                    locales:
                      - pl
                  - code: PM
                    currency: EUR
                    locales:
                      - fr
                  - code: PN
                    currency: NZD
                    locales:
                      - en
                  - code: PR
                    currency: USD
                    locales:
                      - es
                      - en
                  - code: PS
                    currency: ILS
                    locales:
                      - ar
                      - he
                      - en
                  - code: PT
                    currency: EUR
                    locales:
                      - pt
                  - code: PW
                    currency: USD
                    locales:
                      - en
                  - code: PY
                    currency: PYG
                    locales:
                      - es
                      - gn
                  - code: QA
                    currency: QAR
                    locales:
                      - ar
                  - code: RE
                    currency: EUR
                    locales:
                      - fr
                  - code: RO
                    currency: RON
                    locales:
                      - ro
                  - code: RS
                    currency: RSD
                    locales:
                      - sr
                  - code: RU
                    currency: RUB
                    locales:
                      - ru
                  - code: RW
                    currency: RWF
                    locales:
                      - rw
                      - en
                      - fr
                  - code: SA
                    currency: SAR
                    locales:
                      - ar
                  - code: SB
                    currency: SBD
                    locales:
                      - en
                  - code: SC
                    currency: SCR
                    locales:
                      - fr
                      - en
                  - code: SD
                    currency: SDG
                    locales:
                      - ar
                      - en
                  - code: SE
                    currency: SEK
                    locales:
                      - sv
                  - code: SG
                    currency: SGD
                    locales:
                      - en
                      - ms
                      - ta
                  - code: SH
                    currency: SHP
                    locales:
                      - en
                  - code: SI
                    currency: EUR
                    locales:
                      - sl
                  - code: SJ
                    currency: NOK
                    locales:
                      - 'no'
                  - code: SK
                    currency: EUR
                    locales:
                      - sk
                  - code: SL
                    currency: SLE
                    locales:
                      - en
                  - code: SM
                    currency: EUR
                    locales:
                      - it
                  - code: SN
                    currency: XOF
                    locales:
                      - fr
                  - code: SO
                    currency: SOS
                    locales:
                      - so
                      - ar
                  - code: SR
                    currency: SRD
                    locales:
                      - nl
                  - code: SS
                    currency: SSP
                    locales:
                      - ar
                      - en
                  - code: ST
                    currency: STN
                    locales:
                      - pt
                  - code: SV
                    currency: USD
                    locales:
                      - es
                  - code: SX
                    currency: XCG
                    locales:
                      - nl
                      - en
                  - code: SY
                    currency: SYP
                    locales:
                      - ar
                  - code: SZ
                    currency: SZL
                    locales:
                      - en
                      - ss
                  - code: TC
                    currency: USD
                    locales:
                      - en
                  - code: TD
                    currency: XAF
                    locales:
                      - ar
                      - fr
                  - code: TG
                    currency: XOF
                    locales:
                      - fr
                  - code: TH
                    currency: THB
                    locales:
                      - th
                  - code: TJ
                    currency: TJS
                    locales:
                      - tg
                      - ru
                  - code: TK
                    currency: NZD
                    locales:
                      - en
                  - code: TL
                    currency: IDR
                    locales:
                      - pt
                  - code: TM
                    currency: TMT
                    locales:
                      - tk
                  - code: TN
                    currency: TND
                    locales:
                      - ar
                      - fr
                  - code: TO
                    currency: TOP
                    locales:
                      - en
                      - to
                  - code: TR
                    currency: TRY
                    locales:
                      - tr
                  - code: TT
                    currency: TTD
                    locales:
                      - en
                  - code: TV
                    currency: AUD
                    locales:
                      - en
                  - code: TW
                    currency: TWD
                    locales:
                      - zh-CN
                  - code: TZ
                    currency: TZS
                    locales:
                      - sw
                      - en
                  - code: UA
                    currency: UAH
                    locales:
                      - uk
                  - code: UG
                    currency: UGX
                    locales:
                      - en
                      - sw
                  - code: US
                    currency: USD
                    locales:
                      - en
                  - code: UY
                    currency: UYU
                    locales:
                      - es
                  - code: UZ
                    currency: UZS
                    locales:
                      - uz
                  - code: VA
                    currency: EUR
                    locales:
                      - it
                      - la
                  - code: VC
                    currency: XCD
                    locales:
                      - en
                  - code: VE
                    currency: VES
                    locales:
                      - es
                  - code: VG
                    currency: USD
                    locales:
                      - en
                  - code: VI
                    currency: USD
                    locales:
                      - en
                  - code: VN
                    currency: VND
                    locales:
                      - vi
                  - code: VU
                    currency: VUV
                    locales:
                      - bi
                      - en
                      - fr
                  - code: WF
                    currency: XPF
                    locales:
                      - fr
                  - code: WS
                    currency: WST
                    locales:
                      - sm
                      - en
                  - code: YE
                    currency: YER
                    locales:
                      - ar
                  - code: YT
                    currency: EUR
                    locales:
                      - fr
                  - code: ZA
                    currency: ZAR
                    locales:
                      - af
                      - en
                      - nr
                      - st
                      - ss
                      - tn
                      - ts
                      - ve
                      - xh
                      - zu
                  - code: ZM
                    currency: ZMW
                    locales:
                      - en
                  - code: ZW
                    currency: USD
                    locales:
                      - en
                      - sn
                      - nd
      x-codeSamples:
        - lang: javascript
          label: Spree Admin SDK
          source: >-
            import { createAdminClient } from '@spree/admin-sdk'


            const client = createAdminClient({
              baseUrl: 'https://your-store.com',
              secretKey: 'sk_xxx',
            })


            // Each country comes with the currency and languages the store
            would start with.

            const { countries } = await client.auth.setupCountries()
        - lang: bash
          label: Spree CLI
          source: spree api get /auth/setup/countries

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.