Vividly API

Connect your systems to Vividly.

A documented way to view, create, update, and export data across customers, products, pricing, promotions, forecasts, budgets, revenue, spend, and settlement reports.

See code examples Talk to our team

What you can build

Make Vividly part of your operating system.

Representative operations

Keep customers and products aligned

See code examples

GET /customers/ GET /products/ POST /customers/bulk-create/

GET /promotion_lines/ GET /promotions/export GET /revenue/

POST /drm/erp_transactions/upsert/ GET /drm/invoices/ GET /drm/invoice-lines/

POST /export/create/ GET /export/ GET /export/{job_id}/

Get started

From first request to production workflow.

Choose a language below to see a request example, then switch to the response tab to see the documented response shape.

See it in action

Create an account

Start with an account, then create the credentials your integration will use.

Generate an API token

Use the API token in the Authorization header.

Make your first request

Choose an endpoint and provide the required headers and parameters.

Build your workflow

Use the documented create, update, retrieve, bulk, upsert, and export operations.

See it in action

Choose your language. Then inspect the response.

Use the samples below to explore Shell, Ruby, Node.js, and Python requests without leaving the page.

Questions, answered

Frequently asked questions.

What is the Vividly API?

The Vividly API is a documented interface for viewing, creating, updating, and exporting data managed in Vividly.

What data can I access?

The API includes operations for customers, products, promotions, forecasts, budgets, pricing, revenue, settlement reports, and spend.

How is the API authenticated?

The API uses API tokens supplied in the Authorization header. Endpoint examples also use a company UUID header.

Which code examples are available?

This page includes clickable Shell, Ruby, Node.js, and Python request examples, along with an example response shape.

Build a more connected path to profitable growth.

Every CPG brand has different data, trade investment, retailer relationships, and growth priorities. Start a conversation with Vividly to explore where RGM can create the most value for your business.

Talk to our RGM team