Skip to content
Last updated

Getting started

This page walks through making your first request against the Dentally NexGen API. It assumes you already have credentials issued through the partner onboarding process — see Authentication if you do not.

1. Pick a base URL

Base URLs are declared in the OpenAPI document's servers block.

2. Choose a version

Send the Dentally-API-Version request header on every call. Pin to a specific dated revision so a future default rollover does not surprise your client:

Dentally-API-Version: 2026-01-01

If you omit the header you will be routed to the current default version and receive a Warning: 299 response header reminding you to pin. See Versioning for the full lifecycle.

3. Include scope and credentials

Every request needs:

  • An Authorization: Bearer <jwt> header carrying your access token.
  • An X-Practice-Id header — the UUID of the practice the request is scoped to.

4. Make the call

curl --request GET \
  --url 'http://api-test.dentally.com/v2/sites' \
  --header 'Authorization: Bearer <jwt>' \
  --header 'Dentally-API-Version: 2026-01-01' \
  --header 'X-Practice-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6'

A successful response returns the data envelope plus pagination metadata:

{
  "data": [
    {
      "id": "8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c",
      "name": "Dentally High Street"
    }
  ],
  "meta": {
    "cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"
  }
}

5. Next steps

  • Browse the API reference to discover the full set of operations.
  • Read Pagination to walk through subsequent pages.
  • Read Rate limiting to stay within API limits.
  • Read Errors to handle failure responses correctly.

Introduction

Authentication