API keys
Create a key for your own scripts and integrations, call the Smileline API with it, and revoke it when you're done.
An API key lets your own script or integration call the Smileline API — for example to pull leads into a spreadsheet or push enquiries in from another system. You create and revoke keys yourself in Settings → Integrations → API keys.
Building an app that other practices will connect? Use OAuth instead, so each practice approves the app and can disconnect it.
Before you create one
- A key acts as you. It can read and change exactly what your role allows, in every practice you belong to. Removing you from a practice, or changing your role, changes what the key can do straight away.
- Keys belong to the person who made them. Nobody else in the practice sees or manages your keys.
- Each key can make up to 300 requests a minute.
- Keys cannot open clinical records, your account or billing — those need you signed in to Smileline.
- The page is available to everyone who uses the CRM. Clinical-only roles (dentist, hygienist, nurse) don't see it.
Treat a key like a password. Don't put it in a website, a shared document or a code repository, and revoke any key you no longer use.
Create a key
Open Settings → Integrations → API keys and click New API key.
Give it a name that says what will use it, such as Reporting script, and click Create key.
Copy the key and store it somewhere safe. It is shown only once — if you lose it, revoke it and create a new one.
Call the API
The How to connect section of the page shows the three values you need, each with a Copy button:
- API address — your practice's regional API,
https://api-eu.smileline.ioorhttps://api-us.smileline.io. Always copy it from the page. - Practice ID — sent as the
X-Organization-IDheader. You need it if you belong to more than one practice; it does no harm otherwise. - A ready-made test command.
Send the key as a Bearer token on every request:
curl https://api-eu.smileline.io/auth/me \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "X-Organization-ID: YOUR_PRACTICE_ID"A working key returns your name, the practice and your role. Every endpoint is listed in the API reference, and each page there has a playground you can paste the key into.
Revoke a key
Under Your keys, each key shows its name, its first few characters, when it was created and when it was last used. Click Revoke and confirm. Anything using that key stops working straight away, and this can't be undone.