For the complete documentation index, see llms.txt. This page is also available as Markdown.

Me

GET /me

Returns the store the key reads, its Elevate plan and its currency. It takes no parameters and is the quickest way to check that a key works.

Response

Field
Type
What it holds

storeId

string

The store's myshopify.com domain

plan

string | null

The store's Elevate plan, null while no plan is active

currency

string | null

The currency every money value in the API is reported in

curl https://elevateab.app/api/external/v1/me \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "success": true,
  "data": {
    "storeId": "your-store.myshopify.com",
    "plan": "Standard",
    "currency": "USD"
  }
}

Worth knowing

Use it in a health check before a batch of heavier calls: it is the cheapest request in the API.

Last updated