{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting started","siteUrl":"https://docs.api.dentally.com"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started","__idx":0},"children":["Getting started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/pages/authentication"},"children":["Authentication"]}," if you do not."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-pick-a-base-url","__idx":1},"children":["1. Pick a base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Base URLs are declared in the OpenAPI document's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["servers"]}," block."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-choose-a-version","__idx":2},"children":["2. Choose a version"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dentally-API-Version"]}," request header on every call. Pin to a"," ","specific dated revision so a future default rollover does not surprise your"," ","client:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Dentally-API-Version: 2026-01-01\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you omit the header you will be routed to the current default version and"," ","receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Warning: 299"]}," response header reminding you to pin. See"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/pages/versioning"},"children":["Versioning"]}," for the full lifecycle."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-include-scope-and-credentials","__idx":3},"children":["3. Include scope and credentials"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every request needs:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization: Bearer <jwt>"]}," header carrying your access token."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Practice-Id"]}," header — the UUID of the practice the request is scoped to."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-make-the-call","__idx":4},"children":["4. Make the call"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --request GET \\\n  --url 'http://api-test.dentally.com/v2/sites' \\\n  --header 'Authorization: Bearer <jwt>' \\\n  --header 'Dentally-API-Version: 2026-01-01' \\\n  --header 'X-Practice-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful response returns the data envelope plus pagination metadata:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"8c7f4c9b-0e3d-5f2a-b6c7-4d8e9f0a1b2c\",\n      \"name\": \"Dentally High Street\"\n    }\n  ],\n  \"meta\": {\n    \"cursor\": \"eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-next-steps","__idx":5},"children":["5. Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Browse the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference"]}," to discover the full set of operations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/pages/pagination"},"children":["Pagination"]}," to walk through subsequent pages."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/pages/rate-limiting"},"children":["Rate limiting"]}," to stay within API limits."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/pages/errors"},"children":["Errors"]}," to handle failure responses correctly."]}]}]},"headings":[{"value":"Getting started","id":"getting-started","depth":1},{"value":"1. Pick a base URL","id":"1-pick-a-base-url","depth":2},{"value":"2. Choose a version","id":"2-choose-a-version","depth":2},{"value":"3. Include scope and credentials","id":"3-include-scope-and-credentials","depth":2},{"value":"4. Make the call","id":"4-make-the-call","depth":2},{"value":"5. Next steps","id":"5-next-steps","depth":2}],"frontmatter":{"seo":{"title":"Getting started"}},"lastModified":"2026-07-14T23:55:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/pages/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}