Retrieving Lists in CRM

CRM lists are data selections needed for integrations: duplicates by phone and email, CRM activities related to deals, stages, funnels, addresses, vendors, and entities at a selected stage.

A scenario is a sequence of requests for a single task. It describes the order of method calls and provides a code example.

Quick navigation: all scenarios

Interaction with CRM ObjectsInteraction with CRM Objects

Scenarios are linked to clients, deals, SPAs, and inventory management.

• Leads, contacts, and companies. Duplicates are searched by phone and email, then data for leads, contacts, and companies is retrieved. The client's address is stored in requisites.
• Deals. The list of activities is built by ID of deals. Stages and funnels help select deals for subsequent actions in CRM. Basic operations are performed using the methods crm.deal.*.
• SPAs. Entities are filtered by stages through entityTypeId — the identifier for the CRM object type. Entities can be retrieved using universal methods crm.item.*.
• Vendors. Vendors are obtained from contacts or companies by category. The retrieved identifiers are passed to the inventory management method catalog.documentcontractor.add.

How to Get StartedHow to Get Started

1. Identify the CRM object: lead, contact, company, deal, or SPA.
2. Find the required scenario in the table How to Choose a Scenario.
3. Check what access permissions and scopes are specified in the selected scenario.
4. Execute the methods in the order described in the scenario.
5. Use the obtained identifiers in subsequent CRM or inventory management requests.

How to Choose a ScenarioHow to Choose a Scenario

If you need	Open
Find duplicate leads, contacts, and companies by phone or email	How to Find Duplicates in CRM by Phone and Email
Gather activities related to a salesperson's deals and display responsible parties	How to Get a List of Activities from Deals
Retrieve CRM stages and semantic values for analyzing the object's status	How to Get a List of Stages with Semantics for CRM Objects
Get deal funnels and stages within each funnel	How to Get Deal Funnels with Semantics for Each Stage
Retrieve client requisites and the associated address	How to Get Client Address from CRM
Find vendors among contacts or companies	How to Get a List of Vendors
Match stage names with identifiers and retrieve entities by filter	How to Filter Entities by Stage Name