My Portal

Articles in this section

Getting Started with the Practice Better API (Beta)

Avatar
Help @ Practice Better
Updated
Follow

The Practice Better API empowers you to seamlessly retrieve, update, and create data within your Practice Better account through a RESTful interface. Currently available in public beta for users on paid plans, this powerful tool helps you integrate Practice Better with your existing workflows and systems.

⚠️ There is no charge for the API add-on as it is available to customers in public beta. However, pricing for this add-on will be introduced and applicable to all customers once the beta period has concluded. Notice will be provided to those participating ahead of time.

Adding the API Access Add-on

To begin using the Practice Better API, you'll first need to add the API Access add-on to your subscription.

  1. Open the My Profile menu in the top-right corner of your portal and select My Subscription.

     
  2. Click the View add-ons button near the bottom of the My Subscription page.

     
  3. Select API Access (Beta) from the list of available add-ons.

     
  4. Agree to the terms to continue: Our API Access add-on is currently in public beta and avallable to users looking to retrieve data from their. Practice Better account using a RESTful API. You'll be able to create API Keys and access the API documentation once you've added the add-on to your account. Currently there is no charge for the Open API add-on as it is available to customers in public beta. However, pricing for this add-on will be introduced and applicable to all customers in the near future once the Beta period has concluded.

📍 Note: Our support team will review your request before you can add the add-on to your account. This ensures you have the guidance and resources you need for successful implementation.

Creating an API Key

Once your request has been approved (you will receive an email response), the API add-on will be added to your subscription, and you can create an API Key to programmatically access your account data. Your API key serves as your secure gateway to Practice Better's data and features.

  1. Click the Settings & Preferences icon in the top-right corner of your portal and select All Settings & Preferences.

     
  2. Select API Access from the settings menu.
     
  3. On the API Access page, click Create key to create your first API key.

     
  4. Enter a memorable name and an optional whitelist if you wish to restrict the use of the API key to specific IP addresses. Set the access restrictions for your key, then click Create to continue.

     
  5. The next popup will display Your API key and secret.

Once you've created your key, you can submit API requests by following the documentation.

⚠️ Important: Make sure you store the secret securely since you won't be able to access it once the popup is closed. Treat your API credentials like passwords — they provide direct access to your Practice Better account data.

Making API Requests

You'll first need to obtain a token to retrieve or update data in your account. This can be done by exchanging your Client ID and Client Secret via the Auth Token endpoint. The token has a short-lived lifespan for making requests. Once the token expires, you'll need to make another request to the OAuth endpoint to generate a new token.

Running Examples in the Documentation

Using the right navigation pane, you can run examples of each endpoint directly in the documentation. You'll first need to generate an OAuth token from the Auth Token page:
Enter the Client ID and Client Secret you obtained in the Creating an API Key section, and then click Send API Request to generate a bearer token. Once you've generated a token, you can then use the token when testing other endpoints in the documentation:
💡 Tip: Testing endpoints directly in the documentation is a great way to familiarize yourself with API responses before writing any code.

Running Examples in Postman

You can also export the API specification and import it into Postman. Go to our API Documentation page and click Export in the top-right corner:
Click Original to download the API Specification. Once you've downloaded the specification, import it into Postman using the following instructions. 
💡 Tip: Using Postman allows you to organize your API requests, save examples, and collaborate with team members who may be helping with your integration.

Related articles

Article is closed for comments.