# About the Pipelines API

The Pipelines API enables you to create and manage pipeline systems for tracking multi-step business processes in Wix CRM. A pipeline is a customizable system that organizes your business process into a series of ordered stages. For example, a sales funnel, hiring workflow, project management process, or other custom business operations. Individual items such as deals or business leads move through the pipeline stages to a final outcome. 

With the Pipelines API, you can:

- Create, update, and delete custom pipelines.
- Organize pipelines with tags for easier management and filtering.
- Query and filter pipelines based on various criteria.

## Before you begin

It's important to note the following points before starting to code:

- The Pipelines API works closely with the [Cards API](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/introduction). Cards represent the actual deals, leads, or opportunities that move through your pipeline stages.
- All pipelines must have at least 1 stage in addition to the `doneStage`. 
- The `doneStage` must have at least 1 allowed outcome.
- Once you set a pipeline's currency value, you can't change it.
- You can't delete any pipelines or regular stages that contain cards.
- You can't delete a pipeline's `doneStage`. 


## Terminology

- **Pipeline**: A structured workflow consisting of multiple ordered stages that represents a business process. Pipelines define the path that cards follow from start to completion.
- **Stage**: A specific step or phase in a pipeline that represents a particular state in the business process.
- **Done stage**: The final stage of the pipeline that serves as the end point of a business process where cards conclude their workflow. Done stages specify allowed outcomes and every pipeline must have exactly 1 `doneStage`.
- **Stale duration**: The duration, in hours, that a card can remain in a stage before becoming stale. This helps identify workflow bottlenecks and cards that may need attention.
- **Outcome**: The final result of a card when it reaches the final stage. Can be `NONE`, `WON`, or `LOST`. The final stage must specify at least 1 allowed outcome that cards can have when moved to completion. This determines what final states are possible for items in your pipeline.
- **Card**: Items that move through pipeline stages, representing deals, leads, projects, and more business entities tracked through a process. You can manage cards using the [Cards API](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/introduction).
- **Tags**: Keywords used to categorize and organize pipelines for filtering and tracking purposes. 

@sdk_package_setup

# Pipeline Management: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support using both the Pipelines and Cards APIs. These flows provide useful starting points as you plan your implementation.

## Track deals for small sales teams

You can create a simple deal tracking system that helps small businesses organize their sales opportunities in one place.

To track deals for a small sales team:

1. Call [Create Pipeline](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/pipelines/create-pipeline) to create a sales pipeline. 

2. Call [Create Card](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/create-card) to add deals with customer information:

3. Call [Move Card](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/move-card) to move deals through stages as they progress.

4. Call [Query Cards](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/query-cards) to view active deals.

5. Call [Search Cards](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/search-cards) with aggregations to generate basic sales reports.

## Create event pipeline for event planning

You can create an event planning system that helps event planners track their events from initial planning through completion. 

To create and manage an event pipeline:

1. Call [Create Pipeline](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/pipelines/create-pipeline) to create an event planning pipeline. For example, you can create stages like "Event Planning", "Vendors Booked", "Final Details", and "Event Complete" as the final stage. 

2. Call [Create Card](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/create-card) to create event cards with client and vendor contacts. 

3. Call [Bulk Update Card Tags](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/bulk-update-card-tags) to organize multiple events by type.

4. Call [Query Cards](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/query-cards) to monitor upcoming events and deadlines.


## Integrate pipeline data with external CRM systems

You can synchronize pipeline and card data with external CRM systems by using events and API queries.

To integrate pipeline data with external CRM systems:

1. Listen for events, for example:
  - [Card Created](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/create-card)
  - [Card Moved](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/card-moved)
  - [Card Updated](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/card-updated)
  - [Pipeline Updated](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/pipelines/pipeline-updated)

2. When an event occurs, sync the data to your external CRM:

3. Call [Query Pipelines](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/pipelines/query-pipelines) and [Search Cards](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/cards/search-cards) to perform regular synchronization checks.

# Pipelines: Supported Filters and Sorting

The following table shows field support for filters and sorting for the Pipelines object: 

| Field           | Supported Filters                          | Sortable  |
|-----------------|--------------------------------------------|-----------|
| `id`            | `$eq`, `$ne`, `$in`, `$nin`                |           |
| `createdDate`   | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable  |
| `updatedDate`   | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable  |
| `name`          | `$eq`, `$ne`, `$in`, `$nin`, `$startsWith` | Sortable  |



__Related content:__
[API Query Language](fallback::https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language),
[Query Pipelines](fallback::https://dev.wix.com/docs/api-reference/crm/crm/pipelines-management/pipelines/query-pipelines)