About the Cards API

The Cards API enables you to create and manage the individual records that move through your pipelines. Cards represent specific deals, leads, or opportunities in your workflow. Each card contains information such as associated contact, monetary values, due dates, and more.

With the Cards API, you can:

• Create, update, and delete cards.
• Move cards between different pipeline stages and track their progress.
• Associate cards with multiple contacts and assign team members to cards.
• Organize cards with tags and connect them to other business entities such as orders or invoices.
• Query or search cards with filtering, sorting, full-text search, and aggregation capabilities.

Before you begin

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

• Cards must be associated with an existing pipeline and stage. Use the Pipelines API to create pipelines and stages before creating cards.
• Cards can only be moved between stages in the same pipeline.
• When associating contacts with cards, make sure the contact IDs exist in the site's contact list. Cards can have 1 main contact and up to 10 additional contacts.
• When moving cards to the final stage, specify a valid outcome that matches the allowed outcomes of the doneStage.
• Cards become stale automatically based on the stage's stale duration setting, while the overdue status is based on the card's due date.

Terminology

• Card: An item representing a deal, lead, or any business opportunity that moves through a business process pipeline.
• Pipeline: A structured workflow consisting of multiple ordered stages that represents a business process.
• Stage: A specific step or phase in a pipeline that represents a particular state in the business process.
• Outcome: The result of a card when it reaches the final stage, such as WON, LOST, or NONE.
• Linked entities: External business objects connected to a card, such as orders, invoices, activities, or other relevant entities.
• Tags: Keywords used to categorize and organize cards for filtering and tracking purposes.
• Overdue card: A card that has passed its defined due date without being moved to the next stage, indicating a missed deadline.
• Stale card: A card that has remained in the same stage for too long indicating potential workflow bottlenecks.