RetailHardHat Developer docs

REST API documentation

Your first API request

From a secure key to a successful response in three steps.

1. Create a dedicated API key

Sign in and open Settings → API Keys. An authorized administrator can create a key for your integration. Start with read-only access, apply the available restrictions and keep the key in your server's secret storage.

2. List your sites

Replace the placeholder below with your API key. Never put a real key in shared documentation, frontend code or a public repository.

curl --request GET "/api/v1/sites?page=1&limit=25" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

3. Read the response

This illustrative empty result uses the API's JSON envelope. Real values depend on your organization's data.

{
  "data": [],
  "meta": {
    "totalCount": 0,
    "pageCount": 0,
    "currentPage": 1,
    "perPage": 25
  },
  "errors": null
}

Continue with pagination and requests or find supported operations in the resource directory.