---
title: "Export opportunities, based on opportunity filters"
method: POST
path: "/export/opportunity/"
tags: ["exports"]
---

# Export opportunities, based on opportunity filters

`POST /export/opportunity/`

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](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. 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.

## Response `200`

Successful response

- Export
  - `created_by` string, nullable, required
  - `date_created` string, date-time, required
  - `date_format` 'original' | 'iso8601' | 'excel', required
  - `date_updated` string, date-time, required
  - `download_url` string, nullable, required
  - `fields` string[], required
  - `format` 'csv' | 'json', required
  - `id` string, required
  - `limit` integer, nullable
  - `n_docs` integer, nullable, required
  - `n_docs_processed` integer, required
  - `organization_id` string, required
  - `params` JSONDict
  - `query` string, nullable
  - `results_limit` integer, nullable
  - `s_query` JSONDict
  - `send_done_email` boolean, required
  - `sort` JSONDict[], nullable
  - `status` 'created' | 'started' | 'in_progress' | 'done' | 'error', required
  - `type` 'leads' | 'contacts' | 'lead_opps' | 'opps' | 'opportunities', required
  - `updated_by` string, nullable, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found

---

[API](https://skmtc.dev/close/apis/close-api.md) · [All operations](https://skmtc.dev/close/apis/close-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/close/close-api/revisions/59969f4fe8c1/schema)