---
title: "Export"
method: POST
path: "/profiles/export"
tags: ["Profiles"]
---

# Export

`POST /profiles/export`

Create a request to export profile data.

## Headers

- `X-Batch-Project` string, required

## Request body

- union
  - ExportAttributeRequest
    - `export_type` 'ATTRIBUTES', required — Type of the export events request.
    - `attributes` string[] — List of custom or native attributes to be included in the export file(s). Any value that does not start with a `$` will be interpreted as a custom attribute. A list of native attributes available is provided below: - `$city` - `$creation_date` - `$email_address` - `$email_marketing` - `$language` - `$last_activity` - `$last_email_marketing_click` - `$last_email_marketing_open` - `$last_email_transactional_click` - `$last_email_transactional_open` - `$last_visit_date` - `$phone_number` - `$region` - `$sms_marketing` - `$timezone` - `$push_subscriptions` - `$install_date` - `$email_open_tracking_consent` - `$topic_preferences` - `$device.device_model` - `$device.os_version`
    - `identifiers` string[] — List of profile identifiers to be included in the export file(s).
    - `filter` object — Optional filter to refine the export. A rate limit applies when using this parameter.
      - `segment` string — Code of the segment you want to filter this export with.
      - `include_unreachable` boolean — When set to `true`, the export includes all profiles in the database. By default (`false`), only profiles with at least one custom id, email address, phone number or push token are included.
  - ExportEventRequest
    - `export_type` 'EVENTS', required — Type of the export events request.
    - `from` string, required — UTC date in a RFC 3339. Must be before `to` parameter and not older than the lookback period.
    - `to` string, required — UTC date in a RFC 3339 format or `now`.
    - `identifiers` string[] — List of profile identifiers to be included in the export file(s).
    - `events` string[], required — List of events to be included in the export file(s).
    - `orchestration_ids` string[] — List of orchestrations IDs to be exported. If not provided, all orchestrations will be exported.
  - ExportReachabilityRequest
    - `export_type` 'REACHABILITY', required — Type of the export reachability request.
    - `from` string, required — UTC date in a RFC 3339. Must be before `to` parameter and not older than the lookback period.
    - `to` string, required — UTC date in a RFC 3339 format or `now`.
    - `identifiers` string[] — List of profile identifiers to be included in the export file(s).
    - `channels` string[], required

## Response `202`

If the POST to the API endpoint is successful you will receive an HTTP 202 confirmation and a request id. <br/>Once you get your request id, you can use it to check the export request status with the <a href="/operations/export_view">export view API endpoint</a>.

- object
  - `id` string — The export id associated with your request to be used to get status.

## Other responses

- `400` — The request is malformed
- `401` — The Rest API Key is not valid for this project
- `429` — Too Many Requests
- `500` — Unexpected error
- `503` — Batch's services are under maintenance. Please try again later

---

[API](https://skmtc.net/batch/apis/batch-rest-api.md) · [All operations](https://skmtc.net/batch/apis/batch-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/batch/batch-rest-api/revisions/ec696334ff35/schema)