List sites

GET/v1/sites

Every site the key reaches, with its currency, time zone, and what the key may do there. A site the key does not reach is not listed.

Headers

• Authorizationrequired

  An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

  string

Responses

• 200OK
• 401Unauthorizedmissing_keyinvalid_keykey_expired+1 more
• 403Forbiddenkey_revokedassistant_keykey_without_access+7 more
• 429Too Many Requestsrate_limited
• 500Internal Server Errorserver_error
• 502Bad Gatewayupstream_unavailable

200 OK

• datarequired

  The records, in a stable order.

  array of objects

  5 fields in each

  • accessrequired

    What this key may do at the site.

    object

    2 fields

    • cataloguerequired

      Products, categories, modifiers, taxes and menus. read lists them; write also creates and changes them.

      string · one of "none", "read", "write"

    • ordersrequired

      Orders. read looks them up; write also sends new ones.

      string · one of "none", "read", "write"

  • currencyrequired

    The currency the site trades in, ISO 4217. Every amount at this site is in its minor units.

    string

  • idrequired

    The site's id. Every site-level path takes it.

    string

  • namerequired

    The site's name.

    string

  • timeZonerequired

    The site's time zone, IANA. Times in the API are UTC; this says what local time they are.

    string

• nextCursor

  Pass as cursor to get the next page. Absent on the last page.

  string

curlJavaScriptPython

curl "https://api.dev.dnerohq.com/v1/sites" \
  -H "Authorization: Bearer $DNERO_API_KEY"

const response = await fetch('https://api.dev.dnerohq.com/v1/sites', {
  headers: {
    Authorization: `Bearer ${process.env.DNERO_API_KEY}`,
  },
})
const data = await response.json()

import os
import requests

response = requests.get(
    "https://api.dev.dnerohq.com/v1/sites",
    headers={"Authorization": f"Bearer {os.environ['DNERO_API_KEY']}"},
)
data = response.json()

200OKapplication/json

{
  "data": [
    {
      "access": {
        "catalogue": "none",
        "orders": "none"
      },
      "currency": "NZD",
      "id": "9a3c74c2-741e-48c3-ad9e-b137ec1c7243",
      "name": "Harbour Street",
      "timeZone": "Pacific/Auckland"
    }
  ],
  "nextCursor": "NmFkN2JjODU3ZWE1NzNiNGQ1NDEyNTg4"
}

401Unauthorizedapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#missing_key",
  "title": "Unauthorized",
  "status": 401,
  "detail": "No API key was sent.",
  "code": "missing_key"
}

403Forbiddenapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#key_revoked",
  "title": "Forbidden",
  "status": 403,
  "detail": "The key was revoked or switched off in the Dnero portal.",
  "code": "key_revoked"
}

429Too Many Requestsapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The key has used its requests for this minute.",
  "code": "rate_limited"
}

500Internal Server Errorapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#server_error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Something went wrong on Dnero's side. It has been logged.",
  "code": "server_error"
}

502Bad Gatewayapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#upstream_unavailable",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Something Dnero depends on did not answer in time.",
  "code": "upstream_unavailable"
}

Examples use this site's API host. Keep the key in $DNERO_API_KEY; never paste it into code.