v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB
Installation

List Installations

Returns the partner's installations — one per (product × practice connection). Each row carries the connected practice and product and survives the install/uninstall cycle (deactivated installs are returned too).

get/partner/installations

Query parameters

limitinteger

Allows limiting the number of installations returned.

offsetinteger

Allows offsetting the start of the returned page.

statusstring

Filter by installation status (onboarding, pending, active, deactivated).

created_atstring date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

partner_productstring

Filter by the public id of the partner product.

Response

Successful response

idstring
auto_grant_partner_app_accessstring
default_partner_app_admin_rolestring
default_partner_app_non_admin_rolestring
statusstring