Export leads based on a search query | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/export/lead/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "date_format": "iso8601",
  "format": "csv",
  "s_query": {
    "queries": [
      {
        "object_type": "lead",
        "type": "object_type"
      },
      {
        "condition": {
          "mode": "full_words",
          "type": "text",
          "value": "ACME Inc."
        },
        "field": {
          "field_name": "name",
          "object_type": "lead",
          "type": "regular_field"
        },
        "type": "field_condition"
      }
    ],
    "type": "and"
  },
  "send_done_email": false,
  "sort": [
    {
      "direction": "desc",
      "field": {
        "field_name": "date_created",
        "object_type": "lead",
        "type": "regular_field"
      }
    }
  ],
  "type": "leads"
}'

{
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2014-04-02T15:00:05.190000+00:00",
  "date_format": "iso8601",
  "date_updated": "2014-04-02T23:36:30.719000+00:00",
  "fields": [
    "addresses",
    "contacts",
    "created_by",
    "created_by_name",
    "custom",
    "date_created",
    "date_updated",
    "description",
    "display_name",
    "id",
    "name",
    "status_id",
    "status_label",
    "updated_by",
    "updated_by_name",
    "url"
  ],
  "format": "csv",
  "id": "expo_yasdalskdjjflkahxrvLG8iVupzjoJVRPgrGhJ0A0b3bae",
  "n_docs_processed": 0,
  "organization_id": "orga_alksdjdfjasdfkljasdlkfjfaklsdjf",
  "s_query": {
    "queries": [
      {
        "object_type": "lead",
        "type": "object_type"
      },
      {
        "condition": {
          "mode": "full_words",
          "type": "text",
          "value": "ACME Inc."
        },
        "field": {
          "field_name": "name",
          "object_type": "lead",
          "type": "regular_field"
        },
        "type": "field_condition"
      }
    ],
    "type": "and"
  },
  "send_done_email": false,
  "sort": [
    {
      "direction": "desc",
      "field": {
        "field_name": "date_created",
        "object_type": "lead",
        "type": "regular_field"
      }
    }
  ],
  "status": "created",
  "type": "leads",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
}

You will receive a link to the generated file via email once the export is done.

The exported file is GZIP compressed to make your download and our upload faster. The content-encoding HTTP header will be set to gzip and the content-type HTTP header will be set to text/csv for CSV exports or application/json for JSON exports.

Parameters:

s_query/results_limit/sort (optional) - The Advanced Filtering API parameters used to narrow the exported results down. By default, all leads are exported.
format - Format of the exported file. The choices are: csv, json. JSON is recommended for raw backups or data migrations.
type - Type of the export.
- leads - For CSV exports, it results in one row per lead. For JSON exports, this is the recommended type and is a superset of the other two types.
- contacts - For CSV exports, it results in one row per contact.
- lead_opps - For CSV exports, it results in one row per opportunity.
date_format (optional) - Controls the format of date objects. Note: this only works with the csv format.
- original (default) - A date format that includes microseconds and timezone information.
  - Date: [YYYY]-[MM]-[DD]
  - Date w/ time: [YYYY]-[MM]-[DD] [hh]:[mm]:[ss.sssss]±[hh]:[mm]
- iso8601 (recommended) - An ISO 8601 compatible date representation that does not include microseconds.
  - Date: [YYYY]-[MM]-[DD]
  - Date w/ time: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]±[hh]:[mm]
- excel - An Excel compatible date format. Dates are always in UTC, do not include timezone information or microseconds, and use a 12 hour clock with an AM or PM designation.
  - Date: [YYYY]-[MM]-[DD]
  - Date w/ time: [YYYY]-[MM]-[DD] [hh]:[mm]:[ss] [AM|PM]
fields (optional) - By default we return all the data fields in each export type. If you only need specific fields exported, you can explicitly list them in fields to get smaller exports.
include_activities (optional) - Activities aren’t included in any exports by default. If you want all your Activities exported as well, pass "include_activities": true. Note: this only works for leads type with json format.
include_smart_fields (optional) - Smart Fields aren’t included in any exports by default. If you want all of them exported as well, pass "include_smart_fields": true. Note: this only works for leads type with json format or any type formatted as csv. Smart fields are calculated fields, like number of emails on a lead.
send_done_email - Set to false if you don’t want to get a confirmation email after the bulk action is done.

You will receive a link to the generated file via email once the export is done. The exported file is GZIP compressed to make your download and our upload faster. The `content-encoding` HTTP header will be set to `gzip` and the `content-type` HTTP header will be set to `text/csv` for CSV exports or `application/json` for JSON exports. Parameters: - `s_query/results_limit/sort` (optional) - The [Advanced Filtering API](/resources/advanced-filtering/) parameters used to narrow the exported results down. By default, all leads are exported. - `format` - Format of the exported file. The choices are: `csv`, `json`. JSON is recommended for raw backups or data migrations. - `type` - Type of the export. - `leads` - For CSV exports, it results in one row per lead. For JSON exports, this is the recommended type and is a superset of the other two types. - `contacts` - For CSV exports, it results in one row per contact. - `lead_opps` - For CSV exports, it results in one row per opportunity. - `date_format` (optional) - Controls the format of date objects. Note: this only works with the `csv` format. - `original` (default) - A date format that includes microseconds and timezone information. - Date: `[YYYY]-[MM]-[DD]` - Date w/ time: `[YYYY]-[MM]-[DD] [hh]:[mm]:[ss.sssss]±[hh]:[mm]` - `iso8601` (recommended) - An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compatible date representation that does not include microseconds. - Date: `[YYYY]-[MM]-[DD]` - Date w/ time: `[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]±[hh]:[mm]` - `excel` - An Excel compatible date format. Dates are always in UTC, do not include timezone information or microseconds, and use a 12 hour clock with an AM or PM designation. - Date: `[YYYY]-[MM]-[DD]` - Date w/ time: `[YYYY]-[MM]-[DD] [hh]:[mm]:[ss] [AM|PM]` - `fields` (optional) - By default we return all the data fields in each export type. If you only need specific fields exported, you can explicitly list them in `fields` to get smaller exports. - `include_activities` (optional) - Activities aren't included in any exports by default. If you want all your Activities exported as well, pass `"include_activities": true`. Note: this only works for `leads` type with `json` format. - `include_smart_fields` (optional) - Smart Fields aren't included in any exports by default. If you want all of them exported as well, pass `"include_smart_fields": true`. Note: this only works for `leads` type with `json` format or any type formatted as `csv`. Smart fields are calculated fields, like number of emails on a lead. - `send_done_email` - Set to `false` if you don't want to get a confirmation email after the bulk action is done.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

include_activitiesbooleanOptionalDefaults to false

include_addressesbooleanOptional

include_custom_objectsbooleanOptionalDefaults to false

include_smart_fieldsbooleanOptionalDefaults to false

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

You will receive a link to the generated file via email once the export is done.

Parameters:

s_query/results_limit/sort (optional) - The Advanced Filtering API parameters used to narrow the exported results down. By default, all leads are exported.
format - Format of the exported file. The choices are: csv, json. JSON is recommended for raw backups or data migrations.
type - Type of the export.
- leads - For CSV exports, it results in one row per lead. For JSON exports, this is the recommended type and is a superset of the other two types.
- contacts - For CSV exports, it results in one row per contact.
- lead_opps - For CSV exports, it results in one row per opportunity.
date_format (optional) - Controls the format of date objects. Note: this only works with the csv format.
- original (default) - A date format that includes microseconds and timezone information.
  - Date: [YYYY]-[MM]-[DD]
  - Date w/ time: [YYYY]-[MM]-[DD] [hh]:[mm]:[ss.sssss]±[hh]:[mm]
- iso8601 (recommended) - An ISO 8601 compatible date representation that does not include microseconds.
  - Date: [YYYY]-[MM]-[DD]
  - Date w/ time: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]±[hh]:[mm]
- excel - An Excel compatible date format. Dates are always in UTC, do not include timezone information or microseconds, and use a 12 hour clock with an AM or PM designation.
  - Date: [YYYY]-[MM]-[DD]
  - Date w/ time: [YYYY]-[MM]-[DD] [hh]:[mm]:[ss] [AM|PM]
fields (optional) - By default we return all the data fields in each export type. If you only need specific fields exported, you can explicitly list them in fields to get smaller exports.
include_activities (optional) - Activities aren’t included in any exports by default. If you want all your Activities exported as well, pass "include_activities": true. Note: this only works for leads type with json format.
include_smart_fields (optional) - Smart Fields aren’t included in any exports by default. If you want all of them exported as well, pass "include_smart_fields": true. Note: this only works for leads type with json format or any type formatted as csv. Smart fields are calculated fields, like number of emails on a lead.
send_done_email - Set to false if you don’t want to get a confirmation email after the bulk action is done.