Skip to main content
GET
/
api
/
v2
/
platform
/
users
/
{id}
Return a User
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/users/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "139",
    "type": "user",
    "attributes": {
      "email": "[email protected]",
      "first_name": "Irwin",
      "last_name": "DuBuque",
      "selected_locale": "en",
      "created_at": "2022-11-08T19:35:54.635Z",
      "updated_at": "2022-11-08T19:35:54.635Z",
      "public_metadata": {},
      "private_metadata": {},
      "average_order_value": [],
      "lifetime_value": [],
      "store_credits": []
    },
    "relationships": {
      "bill_address": {
        "data": null
      },
      "ship_address": {
        "data": null
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Query Parameters

​
include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Response

Record found

​
data
object
required