Skip to content
English
  • There are no suggestions because the search field is empty.

API Documentation And Endpoints

When creating the ClientID, you can set the facilities that this ClientID can pull information from, as well as the roles and permissions that this ClientID can have. The API account can be granted permissions for one or more API calls, and for a scope of one or more Vestigo Facilities.

The available endpoints are:

  • BillingAccountContacts - Get
  • BillingAccounts - Get
  • BillingCharges - Get
  • BillingPayments - Get
  • InventoryTransactions - Get
  • Patients - Get
  • PatientSendOuts - Get
  • Prescriptions - Get
  • ProtocolBillingFees - Get
  • ProtocolContacts - Get
  • ProtocolInventory - Get
  • ProtocolPatients - Get
  • Protocols - Get
  • SendOutDetails - Get
  • SendOuts - Get
  • ShipmentReceiptDetails - Get
  • ShipmentReceipts - Get
  • TimeBasedWorkload - Get
  • UserRoles - Get

There can be multiple ClientID’s created with various permissions, but only one of them can have the permission Patients – Get. If a new Client ID is created or an existing ClientID is granted the Patients - Get permission, it will remove it from the other ClientID.

 

Additional Documentation

Additional API documentation, including parameters and sample calls, are available within the Vestigo application. To access this documentation, users (including users who only have an API Management Role) can click on the Help & Support menu, then click on Vestigo API Help Docs link.