v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB

Installation

Connect Installation

Activates a pending installation using the authorization code issued when the practice installed the product. Activates the installation and its practice connection, and returns the installation with the API credentials the practice's app uses to authenticate its requests.

post/partner/installations/connect

Request body

codestring required

The authorization code issued when the practice installed the product.

activateboolean

Defaults to true. Pass false to exchange the code without activating the installation.

Response

Successful response

idstring

auto_grant_partner_app_accessstring

default_partner_app_admin_rolestring

default_partner_app_non_admin_rolestring

statusstring