--- title: Creating an API Client and Secret description: How to create a unique API role that can be assigned to Vestigo User accounts. --- [Skip to content](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/getting-started-with-the-vestigo-api-0-0#main-content) English Show submenu for translations [![Vestigo-Logo-Md-1](https://vestigohelp.mccreadiegroup.com/hs-fs/hubfs/Vestigo-Logo-Md-1.png?width=239&height=75&name=Vestigo-Logo-Md-1.png)](https://vestigohelp.mccreadiegroup.com/en/vestigo?hsLang=en) Open main navigation Close main navigation - English Show submenu for translations - - [Contact Us for Support](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/contacting-support) [Contact Us for Support](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/contacting-support?hsLang=en) What can we help with? - There are no suggestions because the search field is empty. 1. [Vestigo Help Center](https://vestigohelp.mccreadiegroup.com/en/knowledgebase?hsLang=en) 2. [Vestigo Interfaces and Integrations](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-interfaces-and-integrations?hsLang=en) 3. [Vestigo Reporting API](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-interfaces-and-integrations?hsLang=en#vestigo-reporting-api) September 25, 2026 # Creating an API Client and Secret ## A ClientID and secret must be created to connect to the Vestigo Reporting API. 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 and granted the Patients - Get permission, it will remove it from the other ClientID.   ### Creating a ClientID To connect to the Vestigo API, you will need an API Key and API Secret. The API Secret will be available when the account is first created, but will then no longer be visible or accessible by any party. The API Secret should never be shared outside of development use of the API and should follow best security practices. If a Secret has been lost or compromised, the original can be revoked and a new one generated by selecting "Regenerate Secret". 1. Navigate to **Application Administration** 2. Click on **Vestigo API** 3. Click on **Create New Client Secret** 4. Select the appropriate facilities from the **Facility** dropdown 5. Select the available API roles/permissions from the **Roles** dropdown 6. Set an **Expiration** 7. Click Submit It is best practice to set an expiration for no greater than one year and regenerate the secret periodically.   - [From McCreadie Group](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/from-mccreadie-group?hsLang=en#main-content) - [Features in Action! Webinar Series](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/from-mccreadie-group?hsLang=en#features-in-action-webinar-series) - [Updates from the Vestigo Team and McCreadie Group](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/from-mccreadie-group?hsLang=en#updates-from-the-vestigo-team-and-mccreadie-group) - [Vestigo News and Know How](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/from-mccreadie-group?hsLang=en#vestigo-news-and-know-how) - [Vestigo Releases](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/from-mccreadie-group?hsLang=en#vestigo-releases) - [Previous Webinars](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/from-mccreadie-group?hsLang=en#previous-webinars) - [General](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#main-content) - [Vestigo Statement Documents](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#vestigo-statement-documents) - [My Account](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#my-account) - [Patient Profile](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#patient-profile) - [Printers and Labels](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#printers-and-labels) - [Address Book](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#address-book) - [Templates](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#templates) - [Calender](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#calender) - [Workload](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#workload) - [Protocol Specific Users](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/general?hsLang=en#protocol-specific-users) - [Application Administration](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/application-administration?hsLang=en#main-content) - [Client Information and Settings](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/application-administration?hsLang=en#client-information-and-settings) - [Facility Information and Settings](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/application-administration?hsLang=en#facility-information-and-settings) - [Inventory Locations](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/application-administration?hsLang=en#inventory-locations) - [User Accounts and Application Roles/Permissions](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/application-administration?hsLang=en#user-accounts-and-application-roles-permissions) - [Application Admin Audit Logs](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/application-administration?hsLang=en#application-admin-audit-logs) - [Protocols](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#main-content) - [Protocol Management](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#protocol-management) - [Drug and Order Builds](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#drug-and-order-builds) - [Participants and Enrollments](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#participants-and-enrollments) - [Prescriptions](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#prescriptions) - [Protocol Contacts](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#protocol-contacts) - [Documents](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#documents) - [Monitor Visits](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#monitor-visits) - [Protocol Billing and Budgets](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/protocols?hsLang=en#protocol-billing-and-budgets) - [Inventory](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/inventory?hsLang=en#main-content) - [Shipment Receipts](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/inventory?hsLang=en#shipment-receipts) - [Inventory Edits](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/inventory?hsLang=en#inventory-edits) - [Inventory Transfers and Adjustments](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/inventory?hsLang=en#inventory-transfers-and-adjustments) - [Inventory Returns](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/inventory?hsLang=en#inventory-returns) - [Inventory Send Outs](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/inventory?hsLang=en#inventory-send-outs) - [Temperature Excursions](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/inventory?hsLang=en#temperature-excursions) - [Quality Checks](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/inventory?hsLang=en#quality-checks) - [Competencies](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/competencies?hsLang=en#main-content) - [Protocol Competency](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/competencies?hsLang=en#protocol-competency) - [Reports](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/reports?hsLang=en#main-content) - [App Admin Reports](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/reports?hsLang=en#app-admin-reports) - [Protocol Reports](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/reports?hsLang=en#protocol-reports) - [Global Reports](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/reports?hsLang=en#global-reports) - [Billing Reports](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/reports?hsLang=en#billing-reports) - [Billing](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/billing?hsLang=en#main-content) - [Fees](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/billing?hsLang=en#fees) - [Vestigo Interfaces and Integrations](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-interfaces-and-integrations?hsLang=en#main-content) - [CTMS Interface](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-interfaces-and-integrations?hsLang=en#ctms-interface) - [EHR Interface](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-interfaces-and-integrations?hsLang=en#ehr-interface) - [Chain of Custody](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-interfaces-and-integrations?hsLang=en#chain-of-custody) - [Vestigo Reporting API](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-interfaces-and-integrations?hsLang=en#vestigo-reporting-api) - [Barcode Validation](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-interfaces-and-integrations?hsLang=en#barcode-validation) - [Vestigo Digital Learning and Training](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#main-content) - [General Overview](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#general-overview) - [Vestigo for Pre-Clinical Studies](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#vestigo-for-pre-clinical-studies) - [Protocol Build Basics](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#protocol-build-basics) - [Protocol Management](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#protocol-management) - [Inventory Management](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#inventory-management) - [Inventory Transactions](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#inventory-transactions) - [Application Administration](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#application-administration) - [Monitor Visits and Vestigo Verify](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#monitor-visits-and-vestigo-verify) - [Checklists and Workload](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#checklists-and-workload) - [Billing and Budget Management](https://vestigohelp.mccreadiegroup.com/en/knowledgebase/vestigo-digital-learning-and-training?hsLang=en#billing-and-budget-management) [![McCreadie-Logo-Md](https://vestigohelp.mccreadiegroup.com/hs-fs/hubfs/McCreadie-Logo-Md.png?width=347&height=105&name=McCreadie-Logo-Md.png "McCreadie-Logo-Md")](https://mccreadiegroup.com) [mailto:support@mccreadiegroup.com](mailto:support@mccreadiegroup.com) Copyright © 2026, McCreadie Group Software LLC ↑