Skip to content

Get the signed-in identity

GET
/tenant/stores/{storeRef}/auth/me
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/tenant/stores/example/auth/me \
--header 'Authorization: Bearer <token>' \
--header 'x-storefront-api-key: <x-storefront-api-key>'

Returns the signed-in shopper’s identity, the sign-in methods linked to it and the name, avatar and phone of their customer record. Send the shopper’s access token as the customerToken bearer token. The body is empty when the identity no longer exists.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
linked_providers
required

The sign-in methods linked to the identity, such as password or google.

Array<string>
id
required

Identity ID (a UUID).

string
email
required

Email address, or null for an anonymous session.

string
nullable
email_verified
required

Whether the shopper has proved they own the email address.

boolean
is_anonymous
required

True for a session issued by the anonymous route.

boolean
customer_id
required

ID of the customer record linked to this identity, as a string, or null when there is none yet.

string
nullable
name
required

The customer’s name, or null.

string
nullable
avatar_url
required

The customer’s avatar URL, or null.

string
nullable
phone
required

The customer’s phone number, or null.

string
nullable

Example generated

{
"linked_providers": [
"example"
],
"id": "example",
"email": "example",
"email_verified": true,
"is_anonymous": true,
"customer_id": "example",
"name": "example",
"avatar_url": "example",
"phone": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}