> ## 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 all Addresses

> Returns a list of addresses for the current user.



## OpenAPI

````yaml /api-reference/storefront.yaml get /api/v2/storefront/account/addresses
openapi: 3.0.3
info:
  version: 2.0.0
  title: Storefront API
  description: >-
    Storefront API is a modern REST API based on the [JSON API
    spec](https://jsonapi.org/) which provides you with all the necessary
    endpoints to build amazing user interfaces either in JavaScript frameworks
    or native mobile libraries.


    Import to
    [Postman](https://raw.githubusercontent.com/spree/spree/main/docs/api-reference/storefront.yaml)
  contact:
    name: Vendo Connect Inc.
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  license:
    name: BSD-3-Clause
    url: https://github.com/spree/spree/blob/main/LICENSE.md
servers:
  - url: https://demo.spreecommerce.org
    description: demo
  - url: http://localhost:3000
    description: localhost
security: []
tags:
  - name: Account
  - name: Account / Address
  - name: Account / Credit Cards
  - name: Account / Orders
  - name: Cart
  - name: Cart / Line Items
  - name: Cart / Coupons
  - name: Cart / Other
  - name: Checkout
  - name: Checkout / State
  - name: Checkout / Shipments
  - name: Checkout / Payments
  - name: Checkout / Store Credit
  - name: Stripe
  - name: Adyen
  - name: Countries
  - name: Digital Downloads
  - name: Order Status
  - name: Products
  - name: Variants
  - name: Stores
  - name: Policies
  - name: Taxons
  - name: Vendors
  - name: Wishlists
  - name: Wishlists / Wished Items
paths:
  /api/v2/storefront/account/addresses:
    get:
      tags:
        - Account / Address
      summary: List all Addresses
      description: Returns a list of addresses for the current user.
      operationId: addresses-list
      parameters:
        - $ref: '#/components/parameters/SparseFieldsAddress'
        - in: query
          name: filter[exclude_quick_checkout]
          schema:
            type: boolean
          example: true
          description: Exclude addresses that were created during quick checkout
      responses:
        '200':
          $ref: '#/components/responses/AddressList'
        '403':
          $ref: '#/components/responses/403Forbidden'
      security:
        - bearerAuth: []
components:
  parameters:
    SparseFieldsAddress:
      in: query
      name: fields[address]
      example: firstname,lastname,country_name
      description: >-
        Specify the fields you would like returned in the response body. [More
        information](https://jsonapi.org/format/#fetching-sparse-fieldsets).
      schema:
        type: string
  responses:
    AddressList:
      description: 200 Success - Returns an array of `address` objects.
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/Address'
              meta:
                $ref: '#/components/schemas/ListMeta'
              links:
                $ref: '#/components/schemas/ListLinks'
            required:
              - data
              - meta
              - links
          examples:
            Standard response:
              value:
                data:
                  - id: '11'
                    type: address
                    attributes:
                      firstname: Tyler
                      lastname: Durden
                      address1: 12312 Street
                      address2: Basment Entrance
                      city: LA
                      zipcode: '90210'
                      phone: '08173762736'
                      state_name: California
                      company: Paper Street Soap Co
                      country_name: United States
                      country_iso3: USA
                      country_iso: US
                      label: Home
                      state_code: CA
                  - id: '28'
                    type: address
                    attributes:
                      firstname: John
                      lastname: Snow
                      address1: 7735 Old Georgetown Road
                      address2: 2nd Floor
                      city: Bethesda
                      zipcode: '20814'
                      phone: '3014445002'
                      state_name: Maryland
                      company: null
                      country_name: United States
                      country_iso3: USA
                      country_iso: US
                      label: null
                      state_code: MD
                  - id: '29'
                    type: address
                    attributes:
                      firstname: Emma
                      lastname: Carragher
                      address1: 775645 Old Georgetown Road
                      address2: 3rd Floor
                      city: Qethesda
                      zipcode: '90210'
                      phone: '3488545445002'
                      state_name: California
                      company: null
                      country_name: United States
                      country_iso3: USA
                      country_iso: US
                      label: Work
                      state_code: CA
                meta:
                  count: 3
                  total_count: 3
                  total_pages: 1
                links:
                  self: http://localhost:3000/api/v2/storefront/account/addresses
                  next: >-
                    http://localhost:3000/api/v2/storefront/account/addresses?page=1
                  prev: >-
                    http://localhost:3000/api/v2/storefront/account/addresses?page=1
                  last: >-
                    http://localhost:3000/api/v2/storefront/account/addresses?page=1
                  first: >-
                    http://localhost:3000/api/v2/storefront/account/addresses?page=1
    403Forbidden:
      description: 403 Forbidden - You are not authorized to access this page.
      content:
        application/vnd.api+json:
          schema:
            properties:
              error:
                type: string
                example: You are not authorized to access this page.
                default: You are not authorized to access this page.
          examples:
            403 Example:
              value:
                error: You are not authorized to access this page.
  schemas:
    Address:
      type: object
      title: Address
      description: >-
        The Address model holds the customer details, such as name, address, and
        phone number.
      properties:
        id:
          type: string
          example: '1'
        type:
          type: string
          default: address
        attributes:
          type: object
          properties:
            firstname:
              type: string
              example: John
            lastname:
              type: string
              example: Doe
            address1:
              type: string
              example: 1600 Amphitheatre Pkwy
            address2:
              type: string
              example: Suite 1
              nullable: true
            city:
              type: string
              example: Mountain View
            zipcode:
              type: string
              example: '94043'
            phone:
              type: string
              example: (+1) 123 456 789
              nullable: true
            state_name:
              type: string
              example: California
            state_code:
              type: string
              example: CA
              description: State abbreviation
              nullable: true
            country_name:
              type: string
              example: United States of America
            country_iso3:
              type: string
              example: USA
              description: Country ISO3 code
            company:
              type: string
              example: Google Inc.
              description: Company name
              nullable: true
            label:
              type: string
              description: The internal name for this address (Work, Home)
              example: Home
              nullable: true
      required:
        - id
        - type
        - attributes
      x-internal: false
    ListMeta:
      type: object
      x-internal: false
      title: Pagination Meta
      properties:
        count:
          type: number
          example: 7
          description: Number of items on the current listing
        total_count:
          type: number
          example: 145
          description: Number of all items matching the criteria
        total_pages:
          type: number
          example: 10
          description: Number of all pages containing items matching the criteria
    ListLinks:
      x-internal: false
      type: object
      title: Pagination Links
      properties:
        self:
          type: string
          description: URL to the current page of the listing
        next:
          type: string
          description: URL to the next page of the listing
        prev:
          type: string
          description: URL to the previous page of the listing
        last:
          type: string
          description: URL to the last page of the listing
        first:
          type: string
          description: URL to the first page of the listing
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |-
        User token to authorize Cart and Checkout requests.

        It is required to associate Cart with the User.

````