--- title: List of API Endpoints description: Vividly API Endpoints --- [Skip to content](https://knowledge.govividly.com/list-of-api-endpoints#main-content) [Submit a Support Ticket](https://knowledge.govividly.com/kb-tickets/new?hsLang=en) [Open the Vividly portal](https://knowledge.govividly.com/support?hsLang=en) [![hubspot\_survey\_logo\_vividly-4](https://knowledge.govividly.com/hs-fs/hubfs/hubspot_survey_logo_vividly-4.png?width=150&height=32&name=hubspot_survey_logo_vividly-4.png)](https://knowledge.govividly.com/?hsLang=en) Open main navigation Close main navigation - [Submit a Support Ticket](https://knowledge.govividly.com/kb-tickets/new) - [Open the Vividly portal](https://knowledge.govividly.com/support) Search the Vividly Knowledge Base - There are no suggestions because the search field is empty. 1. [Vividly Knowledge Base](https://knowledge.govividly.com/?hsLang=en) 2. [Account Settings](https://knowledge.govividly.com/account-settings?hsLang=en) 3. [API Integrations](https://knowledge.govividly.com/account-settings?hsLang=en#api-integrations) November 3, 2026 # List of API Endpoints ### **Overview** The Vividly API allows you to view, create, and update your data programmatically. Our API documentation includes authentication, available endpoints, request and response examples, and implementation details. **View the documentation here**: [https://portal.govividly.com/api.html#description/introduction](https://portal.govividly.com/api.html#description/introduction) **Note:** You must be logged into the Vividly portal to access the technical documentation. If you're unable to access the documentation, please reach out to support via live chat or email. ### **List of API Endpoints** #### **Deductions Reconciliation** - Bulk Upsert ERP Transactions (POST) - List Invoice Lines (GET) - List Invoice Lines for an Invoice (GET) - List Transactions​ (GET) - List Invoices for a Transaction​ (GET) #### **Export** - List Export Jobs (GET) - Get Export Job (GET) - Create an Export (POST) #### **Pricing** - List pricing data with filters (GET) - Upload pricing data (POST) #### **Products** - List products with filters and pagination (GET) - Update a product by ID (PATCH) - Create multiple products in bulk (POST) - Update multiple products in bulk (PATCH) - Create a new product (POST) #### **Promotions** - List Promotion Lines (GET) - Export promotions (GET) #### **Revenue** - List revenue records (GET) - Bulk Delete revenue records (POST) #### **Settlement Reports** - List settlement reports (GET) #### **Spend** - Export spend (GET) - [Release Notes](https://knowledge.govividly.com/release-notes?hsLang=en) - [Business](https://knowledge.govividly.com/business?hsLang=en#main-content) - [Revenue Dollars](https://knowledge.govividly.com/business?hsLang=en#revenue-dollars) - [Point-of-Sale (POS) Data](https://knowledge.govividly.com/business?hsLang=en#point-of-sale-pos-data) - [Deductions Spend](https://knowledge.govividly.com/business?hsLang=en#deductions-spend) - [Deductions Reconciliation - Getting Started](https://knowledge.govividly.com/business?hsLang=en#deductions-reconciliation-getting-started) - [Deductions Reconciliation - Working Deductions & Automation](https://knowledge.govividly.com/business?hsLang=en#deductions-reconciliation-working-deductions-automation) - [Deductions Reconciliation - Sales Review & Disputes](https://knowledge.govividly.com/business?hsLang=en#deductions-reconciliation-sales-review-disputes) - [Deductions Reconciliation - Reporting](https://knowledge.govividly.com/business?hsLang=en#deductions-reconciliation-reporting) - [Deductions Reconciliation - Troubleshooting](https://knowledge.govividly.com/business?hsLang=en#deductions-reconciliation-troubleshooting) - [Deductions Processing](https://knowledge.govividly.com/business?hsLang=en#deductions-processing) - [Deductions Dashboard](https://knowledge.govividly.com/business?hsLang=en#deductions-dashboard) - [Budget](https://knowledge.govividly.com/business?hsLang=en#budget) - [Cash Application](https://knowledge.govividly.com/business?hsLang=en#cash-application) - [Promotions](https://knowledge.govividly.com/promotions?hsLang=en#main-content) - [Creating New Promotions](https://knowledge.govividly.com/promotions?hsLang=en#creating-new-promotions) - [Promotion Details & Editing Promotions](https://knowledge.govividly.com/promotions?hsLang=en#promotion-details-editing-promotions) - [Views and Statuses](https://knowledge.govividly.com/promotions?hsLang=en#views-and-statuses) - [Search & Filters](https://knowledge.govividly.com/promotions?hsLang=en#search-filters) - [Uploading and Editing Promotions in Bulk via Excel Upload](https://knowledge.govividly.com/promotions?hsLang=en#uploading-and-editing-promotions-in-bulk-via-excel-upload) - [Duration Based Planning](https://knowledge.govividly.com/promotions?hsLang=en#duration-based-planning) - [Scenarios](https://knowledge.govividly.com/scenarios?hsLang=en#main-content) - [Scenario Planning](https://knowledge.govividly.com/scenarios?hsLang=en#scenario-planning) - [Manage](https://knowledge.govividly.com/manage?hsLang=en#main-content) - [Overview](https://knowledge.govividly.com/manage?hsLang=en#overview) - [Hierarchies](https://knowledge.govividly.com/manage?hsLang=en#hierarchies) - [Products](https://knowledge.govividly.com/manage?hsLang=en#products) - [Product Groups](https://knowledge.govividly.com/manage?hsLang=en#product-groups) - [Pricing](https://knowledge.govividly.com/manage?hsLang=en#pricing) - [Lift](https://knowledge.govividly.com/manage?hsLang=en#lift) - [Customers](https://knowledge.govividly.com/manage?hsLang=en#customers) - [Contacts](https://knowledge.govividly.com/manage?hsLang=en#contacts) - [Insights](https://knowledge.govividly.com/insights?hsLang=en#main-content) - [Forecast](https://knowledge.govividly.com/insights?hsLang=en#forecast) - [Promotion Analytics](https://knowledge.govividly.com/insights?hsLang=en#promotion-analytics) - [Finance Analytics](https://knowledge.govividly.com/insights?hsLang=en#finance-analytics) - [Promotion Timing Analysis](https://knowledge.govividly.com/insights?hsLang=en#promotion-timing-analysis) - [Accruals](https://knowledge.govividly.com/insights?hsLang=en#accruals) - [Account Settings](https://knowledge.govividly.com/account-settings?hsLang=en#main-content) - [Permissions](https://knowledge.govividly.com/account-settings?hsLang=en#permissions) - [Promotions (Tags)](https://knowledge.govividly.com/account-settings?hsLang=en#promotions-tags) - [Fund Types](https://knowledge.govividly.com/account-settings?hsLang=en#fund-types) - [Deductions & Revenue](https://knowledge.govividly.com/account-settings?hsLang=en#deductions-revenue) - [Forecast](https://knowledge.govividly.com/account-settings?hsLang=en#forecast) - [API Integrations](https://knowledge.govividly.com/account-settings?hsLang=en#api-integrations) - [Miscellaneous](https://knowledge.govividly.com/account-settings?hsLang=en#miscellaneous) - [Frequently Asked Questions (FAQs)](https://knowledge.govividly.com/frequently-asked-questions-faqs?hsLang=en) - [Office Hours](https://knowledge.govividly.com/office-hours?hsLang=en) [![Chill listening crop-3](https://knowledge.govividly.com/hubfs/Vividly_Symbol_Gradient-1.svg "Chill listening crop-3")](https://portal.govividly.com/) **[Open the Vividly Portal](https://portal.govividly.com/)** Copyright © 2026, Vividly