CLclose
exports

Export opportunities, based on opportunity filters

Changed on

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.
post/export/opportunity/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/export/opportunity/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Response

Successful response

created_bystring nullable required
date_createdstring date-time required
date_format'original' | 'iso8601' | 'excel' required
date_updatedstring date-time required
download_urlstring nullable required
fieldsstring[] required
format'csv' | 'json' required
idstring required
limitinteger nullable
n_docsinteger nullable required
n_docs_processedinteger required
organization_idstring required
paramsJSONDict
querystring nullable
results_limitinteger nullable
s_queryJSONDict
send_done_emailboolean required
sortJSONDict[] nullable
status'created' | 'started' | 'in_progress' | 'done' | 'error' required
type'leads' | 'contacts' | 'lead_opps' | 'opps' | 'opportunities' required
updated_bystring nullable required

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status