About the Pipelines Management APIs

The Pipelines Management APIs enable you to create and manage a system for managing business processes in Wix CRM.

The Pipelines Management APIs include the following integrated services:

  • Pipelines API: Create and manage pipeline structures.
  • Cards API: Create and manage the items that move through pipelines.

Pipelines are customizable structures organized into ordered stages, while cards are individual items that move through those stages. With the Pipelines APIs, you can help businesses organize and track their multi-step processes from start to finish. The APIs provide functionality for creating pipelines, managing stage transitions, and organizing pipelines and cards with tags and filtering capabilities.

Pipelines and cards user flow

The Pipelines and Cards APIs work as a unified system where the Pipelines API defines your pipeline structure and the Cards API manages the items that move through it. Since cards must be associated with existing pipelines and stages, you need to establish the pipeline structure before populating it with any cards.

Here's the typical user flow:

  1. Create a pipeline and define it with ordered stages.
  2. Add cards representing your deals, leads, or opportunities to the pipeline.
  3. Move cards through stages as your business process progresses.
  4. Track outcomes and analyze performance.

Use cases

Terminology

  • Pipeline: A structured system consisting of multiple ordered stages that represents a business process.
  • Card: An individual record representing a deal, lead, or opportunity that moves through pipeline stages.
  • Stage: A specific step or phase in a pipeline representing a particular state in the business process.
  • Done Stage: The required final stage where cards conclude with an outcome.
Did this help?