Close CRM icon

Close CRM

Consume Close CRM API

Actions83

Export (Automation & Bulk Actions) → Export Leads

AI-generated

Overview

This node operation allows exporting lead data from the Close CRM system in bulk. It supports exporting leads in different granularities such as one row per lead, one row per contact, or one row per opportunity. The export can be generated in CSV or JSON format. Users can apply advanced filtering using a JSON search query to narrow down the leads to export. Additional options include customizing date formats, selecting specific fields to include, including activities and smart fields, limiting the number of results, and receiving a notification email when the export is complete. This operation is useful for bulk data extraction, reporting, or data migration scenarios.

Use Case Examples

  1. Export all leads in CSV format with original date format and all fields included.
  2. Export contacts related to leads in JSON format including activities and smart fields.
  3. Export lead opportunities in CSV format with a custom search query to filter leads by status.

Properties

Name Meaning
Format File format of the exported data (CSV or JSON)
Type Granularity of the lead export (one row per lead, contact, or opportunity)
Search Query (s_query JSON) Optional advanced filtering query object to narrow exported leads, provided as JSON string or object.
Additional Fields Additional export options such as date format, fields to include, whether to include activities, smart fields, sending done email notification, and results limit.

Output

JSON

  • id - Unique identifier of the export job or exported data item.
  • status - Status of the export job (e.g., pending, completed).
  • format - Format of the exported file (CSV or JSON).
  • type - Granularity type of the export (leads, contacts, lead opportunities).
  • data - The actual exported data content, structure depends on the format and type.
  • created_at - Timestamp when the export job was created.
  • completed_at - Timestamp when the export job was completed.

Dependencies

  • Close CRM API key credential

Troubleshooting

  • Ensure the Close CRM API key credential is correctly configured and has permissions to access export endpoints.
  • Verify that the search query JSON is valid and correctly formatted to avoid JSON parsing errors.
  • If the export job fails, check the status and error messages returned by the Close CRM API for details.
  • Make sure required parameters like format and type are provided to avoid missing parameter errors.

Links

Discussion