Shop

Shop information and authentication

Get shop information

get

https://dev-api.joy.sohttps://api.joy.so

/rest_api/v2/whoami

Retrieve safe shop information for the authenticated shop

Header parameters

X-Joy-Loyalty-App-KeystringRequired

App ID of your shop which retrieved from the Settings page

Example: {{appKey}}

X-Joy-Loyalty-Secret-KeystringRequired

Secret Key of your shop which retrieved from the Settings page

Example: {{secretKey}}

Responses

200

Shop information

application/json

successbooleanOptionalExample: true

metaobjectOptional

Additional metadata such as counts and pagination

messagestringOptionalExample: Operation completed successfully

timestampstring · date-timeOptionalExample: 2023-07-28T07:27:54.123Z

get

/rest_api/v2/whoami

HTTPcURLJavaScriptPython

GET /rest_api/v2/whoami HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: text
X-Joy-Loyalty-Secret-Key: text
Accept: */*

200

Shop information

{
  "success": true,
  "data": {
    "id": "text",
    "name": "text",
    "domain": "text",
    "email": "text",
    "plan": "text",
    "currency": "text",
    "timezone": "text",
    "countryCode": "text",
    "isInstalled": true,
    "createdAt": "2026-03-31T17:02:27.495Z",
    "updatedAt": "2026-03-31T17:02:27.495Z"
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}