CLclose
exports

Get a single Opportunity Export

Changed on

Get a single opportunity export to do things like check its status or get a download_url.

status can have one of these values: created, started, in_progress, done, error.

get/export/opportunity/{id}/

Request

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

Path parameters

idstring required

Query parameters

_fieldsstring

Comma-separated list of fields to include in the response.

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 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

  • 4395b41ac554Revision changes
    • info

      endpoint added