- Community
- Showcase
- Github
- Blog
- Authentication
- Account
- Account / Address
- Account / Credit Cards
- Account / Orders
- Order Status
- Cart
- Cart / Line Items
- Cart / Other
- Cart / Coupons
- Checkout
- Checkout / State
- Checkout / Shipments
- Checkout / Payments
- Checkout / Store Credit
- Products
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
- Authentication
- Addresses
- Adjustments
- Classifications
- CMS Pages
- CMS Sections
- Countries
- Data Feeds
- Digital Links
- Digital Assets
- Line Items
- Menu Items
- Menus
- Option Types
- Option Values
- Orders
- Payment Methods
- Payments
- Products
- Promotion Actions
- Promotion Categories
- Promotion Rules
- Promotions
- Roles
- Shipments
- Shipping Categories
- Shipping Methods
- States
- Stock Items
- Stock Locations
- Store Credit Categories
- Store Credit Types
- Store Credits
- Tax Categories
- Tax Rates
- Taxonomies
- Taxons
- Users
- Variants
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Storefront API
Platform API
Retrieve an Account
Returns the current user details.
User token to authorize Cart and Checkout requests.
It is required to associate Cart with the User.
Pass default_billing_address and/or default_shipping_address as value to include selected addresses information
Specify the fields you would like returned in the response body. More information.
{
"data": {
"id": "1",
"type": "user",
"attributes": {
"email": "spree@example.com",
"first_name": "John",
"last_name": "Snow",
"selected_locale": "en",
"store_credits": 0,
"completed_orders": 0,
"public_metadata": {
"user_segment": "supplier"
}
},
"relationships": {
"default_billing_address": {
"data": {
"id": "2",
"type": "address"
}
},
"default_shipping_address": {
"data": {
"id": "1",
"type": "address"
}
}
}
}
}Authorizations
User token to authorize Cart and Checkout requests.
It is required to associate Cart with the User.
Query Parameters
Pass default_billing_address and/or default_shipping_address as value to include selected addresses information
Specify the fields you would like returned in the response body. More information.
Response
Number of placed Orders by this User
The public metadata for this User
Default billing address associated with this Account
Default shipping address associated with this Account
State abbreviation
Country ISO3 code
Company name
The internal name for this address (Work, Home)
Was this page helpful?
{
"data": {
"id": "1",
"type": "user",
"attributes": {
"email": "spree@example.com",
"first_name": "John",
"last_name": "Snow",
"selected_locale": "en",
"store_credits": 0,
"completed_orders": 0,
"public_metadata": {
"user_segment": "supplier"
}
},
"relationships": {
"default_billing_address": {
"data": {
"id": "2",
"type": "address"
}
},
"default_shipping_address": {
"data": {
"id": "1",
"type": "address"
}
}
}
}
}