Export opportunities, based on opportunity filters

POST

https://api.close.com/api/v1/export/opportunity/

POST

/api/v1/export/opportunity/

curl -X POST https://api.close.com/api/v1/export/opportunity/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "date_format": "iso8601",
  "format": "csv",
  "params": {
    "status_id": "st_id",
    "user_id__in": "id_1,id_2"
  },
  "send_done_email": false
}'

{
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2014-04-01T16:50:22.256000+00:00",
  "date_format": "iso8601",
  "date_updated": "2014-04-02T00:55:34.967000+00:00",
  "download_url": null,
  "fields": [
    "confidence",
    "contact_id",
    "created_by",
    "created_by_name",
    "date_created",
    "date_updated",
    "date_won",
    "id",
    "lead_id",
    "lead_name",
    "note",
    "status_id",
    "status_label",
    "status_type",
    "updated_by",
    "updated_by_name",
    "user_id",
    "user_name",
    "value",
    "value_period"
  ],
  "format": "csv",
  "id": "expo_ASFasdfasdAY8VZhRiSn5UG2wNGRUrRurHdaN7kQp6",
  "n_docs": null,
  "n_docs_processed": 0,
  "organization_id": "orga_klasjd123vxiEY58eTGQmFNG3LPlEVQ4V7Nk",
  "send_done_email": false,
  "status": "created",
  "type": "opps",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "params": {
    "status_id": "st_id",
    "user_id__in": "id_1,id_2"
  }
}

Parameters:

params (optional) - A dictionary of filters, which would be used for the /opportunity/ endpoint.
format - Format of the exported file. The choices are: csv, json
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. If you only need specific fields exported, you can explicitly list them in fields to get smaller exports.
send_done_email - Set to false if you don’t want to get a confirmation email after the bulk action is done.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

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

Request

This endpoint expects any.

Response

Successful response

created_bystring or null

date_createddatetime

date_formatenum

Allowed values:

date_updateddatetime

download_urlstring or null

fieldslist of strings

formatenum

Allowed values:

idstring

n_docsinteger or null

n_docs_processedinteger

organization_idstring

send_done_emailboolean

statusenum

Allowed values:

typeenum

Allowed values:

updated_bystring or null

limitinteger or nullOptional

paramsmap from strings to nullable maps from strings to JSON or lists of JSON or strings or integers or doubles or booleans or nullOptional

querystring or nullOptional

results_limitinteger or nullOptional

s_querymap from strings to nullable maps from strings to JSON or lists of JSON or strings or integers or doubles or booleans or nullOptional

sortlist of maps from strings to nullable JSONDict or lists of JSON or strings or integers or doubles or booleans or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error