Skip to content
BolderBolder API
Esc
↑↓navigate↵open⌘Jpreview

API root

Returns the API entry point. Embeds the authenticated account’s shops and provides navigation links (_links) to all v2 resources.

The products:list link is a URI template — expand it with search parameters to list products.

GET/
Authorization
AuthorizationBearer token (JWT) · headerrequired
Responses
200API root entity
_linksHalLinks
_classstring[]
account_idinteger
account_statusstring
uidinteger
User ID (absent for client_credentials tokens)
emailstring
user_namestring
providerstring
scopesstring
_embeddedobject
Show properties
sellersSeller[]
Show properties
Array of Seller
_linksHalLinks
idinteger
account_idinteger
localestring
currency_codestring
provides_shippingboolean
provides_pickupboolean
prices_include_taxboolean
tax_ratenumber
tax_namestring
products_countinteger
created_onstring<date-time>
updated_onstring<date-time>
shopsShop[]
Show properties
Array of Shop
_linksHalLinks
idinteger
seller_idinteger
account_idinteger
namestring
subdomainstring
urlstring
descriptionstring
localestring
currency_codestring
timezonestring
asset_countinteger
product_countsobject
Show properties
visibleinteger
blockedinteger
hiddeninteger
products_use_variant_pricesboolean
created_onstring<date-time>
updated_onstring<date-time>
401Invalid or missing token
403Access denied
Request
curl -X GET "https://api.onbolder.com/v2/" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "_class": [
    "root"
  ],
  "account_id": 10,
  "account_status": "active",
  "uid": 42,
  "email": "admin@myshop.com",
  "user_name": "admin",
  "provider": "bolder",
  "scopes": "products.read,orders.read,orders.write",
  "_links": {
    "curies": [
      {
        "name": "sellers",
        "href": "https://api.onbolder.com/docs/v2#sellers:{rel}",
        "templated": true
      },
      {
        "name": "products",
        "href": "https://api.onbolder.com/docs/v2#products:{rel}",
        "templated": true
      },
      {
        "name": "shops",
        "href": "https://api.onbolder.com/docs/v2#shops:{rel}",
        "templated": true
      },
      {
        "name": "orders",
        "href": "https://api.onbolder.com/docs/v2#orders:{rel}",
        "templated": true
      },
      {
        "name": "customers",
        "href": "https://api.onbolder.com/docs/v2#customers:{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.onbolder.com/v2"
    },
    "sellers:list": {
      "href": "https://api.onbolder.com/v2/sellers"
    },
    "sellers:show": {
      "href": "https://api.onbolder.com/v2/sellers/{id}",
      "templated": true
    },
    "products:list": {
      "href": "https://api.onbolder.com/v2/products{?q,status,page,per_page,...}",
      "templated": true
    },
    "orders:list": {
      "href": "https://api.onbolder.com/v2/orders{?shop_id,status,page,...}",
      "templated": true
    },
    "customers:list": {
      "href": "https://api.onbolder.com/v2/customers{?shop_id,q,page,...}",
      "templated": true
    }
  },
  "_embedded": {
    "sellers": [
      {
        "id": 5,
        "account_id": 10,
        "locale": "en",
        "currency_code": "USD",
        "products_count": 42,
        "_links": {
          "self": {
            "href": "https://api.onbolder.com/v2/sellers/5"
          },
          "shops:show": {
            "href": "https://api.onbolder.com/v2/shops/1"
          },
          "shops:list": {
            "href": "https://api.onbolder.com/v2/shops?seller_id=5"
          }
        }
      }
    ],
    "shops": [
      {
        "id": 1,
        "name": "My Shop",
        "subdomain": "myshop",
        "url": "myshop.onbolder.com",
        "status": "active"
      }
    ]
  }
}