Get the signed-in shopper's unified marketplace profile
Return a marketplace shopper’s profile and their order history across every merchant in this marketplace.
A purchase belongs to the shopper when it was placed with their credential. A
purchase made as a guest belongs to them once they have verified the email address
it was bought with, by verifying a one-time code or following a sign-in link;
registering an account with that address is not enough. customer.email_verified
reports which applies. A marketplace shopper holds no customer record with any
merchant, so customer.ids is empty.
Requires the marketplace operator key plus exactly one shopper credential:
x-auth-token (a Galactic Core shopper session, also accepted as
X-Customer-Token) or x-external-auth (an assertion signed with the
marketplace’s signing secret).
curl --request GET \
--url https://api.tybritelabs.com/v1/customers/me \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/customers/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tybritelabs.com/v1/customers/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tybritelabs.com/v1/customers/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/customers/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tybritelabs.com/v1/customers/me")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/customers/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"customer": {
"ids": [],
"email": "john.doe@example.com",
"email_verified": true,
"name": "John Doe",
"phone": null,
"address": null,
"status": "active",
"join_date": "2026-06-21"
},
"stores": [
{
"merchant_store_id": "ef7b07d3-424b-4b03-b1d4-30a2d2073b61",
"merchant_store_name": "Galactic Test Store",
"affiliation_date": "2026-06-21T10:22:35.523993+00:00",
"first_purchase_date": "2026-06-21T10:22:35.523993+00:00",
"last_purchase_date": "2026-06-21T10:22:35.523993+00:00",
"total_purchases": 1,
"total_spent": 24.99,
"status": "active",
"preferred_store": false
}
],
"orders": [
{
"id": "102209e8-ebf5-4cfd-9228-23a559b6b769",
"order_number": "MKT-2026-000039-ef7b07d3",
"merchant_store_id": "ef7b07d3-424b-4b03-b1d4-30a2d2073b61",
"merchant_store_name": "Galactic Test Store",
"order_status": "pending",
"payment_status": "paid",
"total_amount": 24.99,
"subtotal": 24.99,
"tax_amount": 0,
"shipping_amount": 0,
"discount_amount": 0,
"tracking_number": null,
"estimated_delivery": null,
"created_at": "2026-06-21T10:22:35.556122+00:00",
"updated_at": "2026-06-21T10:22:35.556122+00:00"
}
]
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "forbidden",
"message": "This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}Authorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): Secret key required - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Headers
The signed-in shopper's session token, obtained when the shopper logs in.
Alias of x-auth-token.
A shopper assertion signed by the marketplace's own backend with the marketplace's signing secret: external_id, iat and exp (at most 300 seconds apart), and optionally email with email_verified: true.
Response
The shopper's marketplace profile.
curl --request GET \
--url https://api.tybritelabs.com/v1/customers/me \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/customers/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tybritelabs.com/v1/customers/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tybritelabs.com/v1/customers/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.tybritelabs.com/v1/customers/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.tybritelabs.com/v1/customers/me")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/customers/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"customer": {
"ids": [],
"email": "john.doe@example.com",
"email_verified": true,
"name": "John Doe",
"phone": null,
"address": null,
"status": "active",
"join_date": "2026-06-21"
},
"stores": [
{
"merchant_store_id": "ef7b07d3-424b-4b03-b1d4-30a2d2073b61",
"merchant_store_name": "Galactic Test Store",
"affiliation_date": "2026-06-21T10:22:35.523993+00:00",
"first_purchase_date": "2026-06-21T10:22:35.523993+00:00",
"last_purchase_date": "2026-06-21T10:22:35.523993+00:00",
"total_purchases": 1,
"total_spent": 24.99,
"status": "active",
"preferred_store": false
}
],
"orders": [
{
"id": "102209e8-ebf5-4cfd-9228-23a559b6b769",
"order_number": "MKT-2026-000039-ef7b07d3",
"merchant_store_id": "ef7b07d3-424b-4b03-b1d4-30a2d2073b61",
"merchant_store_name": "Galactic Test Store",
"order_status": "pending",
"payment_status": "paid",
"total_amount": 24.99,
"subtotal": 24.99,
"tax_amount": 0,
"shipping_amount": 0,
"discount_amount": 0,
"tracking_number": null,
"estimated_delivery": null,
"created_at": "2026-06-21T10:22:35.556122+00:00",
"updated_at": "2026-06-21T10:22:35.556122+00:00"
}
]
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "forbidden",
"message": "This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}
