Users
Return a list of Users
Storefront API
- 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
- Stripe
- Products
- Vendors
- Stores
- Taxons
- Countries
- CMS Pages
- Menus
- Wishlists
- Wishlists / Wished Items
- Digital Downloads
Platform API
- 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
- Vendors
- Webhook Events
- Webhook Subscribers
- Wished Items
- Wishlists
- Zones
Users
Return a list of Users
Returns a list of Users
GET
/
api
/
v2
/
platform
/
users
curl --request GET \
--url http://{defaultHost}/api/v2/platform/users \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "129",
"type": "user",
"attributes": {
"email": "[email protected]",
"first_name": "Liberty",
"last_name": "Becker",
"selected_locale": "nil",
"created_at": "2022-11-08T19:35:53.726Z",
"updated_at": "2022-11-08T19:35:53.726Z",
"public_metadata": {},
"private_metadata": {},
"average_order_value": [],
"lifetime_value": [],
"store_credits": []
},
"relationships": {
"bill_address": {
"data": null
},
"ship_address": {
"data": null
}
}
},
{
"id": "130",
"type": "user",
"attributes": {
"email": "[email protected]",
"first_name": "Chasidy",
"last_name": "Strosin",
"selected_locale": "fr",
"created_at": "2022-11-08T19:35:53.730Z",
"updated_at": "2022-11-08T19:35:53.730Z",
"public_metadata": {},
"private_metadata": {},
"average_order_value": [],
"lifetime_value": [],
"store_credits": []
},
"relationships": {
"bill_address": {
"data": null
},
"ship_address": {
"data": null
}
}
},
{
"id": "131",
"type": "user",
"attributes": {
"email": "[email protected]",
"first_name": "Ruben",
"last_name": "Schmidt",
"selected_locale": "de",
"created_at": "2022-11-08T19:35:53.732Z",
"updated_at": "2022-11-08T19:35:53.732Z",
"public_metadata": {},
"private_metadata": {},
"average_order_value": [],
"lifetime_value": [],
"store_credits": []
},
"relationships": {
"bill_address": {
"data": null
},
"ship_address": {
"data": null
}
}
}
],
"meta": {
"count": 3,
"total_count": 3,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/users?page=1&per_page=&include=&filter[user_id_eq]=&filter[email_cont]=",
"next": "http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page="
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
Response
200
application/vnd.api+json
Records returned
Was this page helpful?
curl --request GET \
--url http://{defaultHost}/api/v2/platform/users \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "129",
"type": "user",
"attributes": {
"email": "[email protected]",
"first_name": "Liberty",
"last_name": "Becker",
"selected_locale": "nil",
"created_at": "2022-11-08T19:35:53.726Z",
"updated_at": "2022-11-08T19:35:53.726Z",
"public_metadata": {},
"private_metadata": {},
"average_order_value": [],
"lifetime_value": [],
"store_credits": []
},
"relationships": {
"bill_address": {
"data": null
},
"ship_address": {
"data": null
}
}
},
{
"id": "130",
"type": "user",
"attributes": {
"email": "[email protected]",
"first_name": "Chasidy",
"last_name": "Strosin",
"selected_locale": "fr",
"created_at": "2022-11-08T19:35:53.730Z",
"updated_at": "2022-11-08T19:35:53.730Z",
"public_metadata": {},
"private_metadata": {},
"average_order_value": [],
"lifetime_value": [],
"store_credits": []
},
"relationships": {
"bill_address": {
"data": null
},
"ship_address": {
"data": null
}
}
},
{
"id": "131",
"type": "user",
"attributes": {
"email": "[email protected]",
"first_name": "Ruben",
"last_name": "Schmidt",
"selected_locale": "de",
"created_at": "2022-11-08T19:35:53.732Z",
"updated_at": "2022-11-08T19:35:53.732Z",
"public_metadata": {},
"private_metadata": {},
"average_order_value": [],
"lifetime_value": [],
"store_credits": []
},
"relationships": {
"bill_address": {
"data": null
},
"ship_address": {
"data": null
}
}
}
],
"meta": {
"count": 3,
"total_count": 3,
"total_pages": 1
},
"links": {
"self": "http://www.example.com/api/v2/platform/users?page=1&per_page=&include=&filter[user_id_eq]=&filter[email_cont]=",
"next": "http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
"prev": "http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
"last": "http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
"first": "http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page="
}
}