---
title: "List"
method: GET
path: "/exports/list"
tags: ["Exports"]
---

# List

`GET /exports/list`

List export requests created.

## Query parameters

- `from` string
- `limit` integer

## Headers

- `X-Batch-Project` string, required

## Response `200`

If the GET to the API endpoint is successful you will receive an HTTP 200 confirmation and information about your export requests. This information is an array of all requests we currently know of for your project. The output contains requests created in the last 4 months.

- object
  - `exports` Request[] — An array of objects describing each export requests.
    - `id` string, required — Id of an export request.
    - `request_date` string — UTC date in a RFC 3339 format.
    - `completion_date` string — UTC date in a RFC 3339 format.
    - `start_date` string — UTC date in a RFC 3339 format.
    - `scope` 'PROFILE_ATTRIBUTES' | 'PROFILE_EVENTS', required
    - `status` 'CREATED' | 'PENDING' | 'RUNNING' | 'ERROR' | 'SUCCESS', required
    - `files` File[], required — All the extraction files available for download if any.
      - `id` string — Id of the extraction file available for download if any.
      - `part` integer — The part number of the file
      - `size` integer — Size of the file in bytes.
      - `url` string — URL to download the file.
    - `request` union, required — The export request definition.
      - object
        - `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.
      - object
        - `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.
  - `count` integer — The number of objects.
  - `has_more` boolean — Whether or not there are more elements available after this set. If `false`, this set comprises the end of the list.
  - `next_from` string — A cursor for use in pagination. If has_more is `true`, you can pass the value of `next_from` to a subsequent call to fetch the next page of results.

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