---
title: "Get Bulk Export Status"
method: GET
path: "/api/ot-insights/v1/bulk-export-jobs/{id}"
tags: ["Bulk Export"]
---

# Get Bulk Export Status

`GET /api/ot-insights/v1/bulk-export-jobs/{id}`

Use this API to retrieve the current status and progress of a bulk export.

> 🗒 Things to Know
> 
> - The `status` of a bulk export will automatically change to `Expired` 10 days after its creation.

## Path parameters

- `id` string, uuid, required — The unique identifier for the bulk export.

## Response `200`

OK

- BulkExportResponse
  - `runId` string, uuid — The unique identifier for the bulk export.
  - `name` string — The name of the bulk export.
  - `status` 'EXPORT_IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'CANCELLED' — The current status of the bulk export.
  - `createdDate` string, date-time — The date and time that the bulk export was initiated.
  - `createdBy` AttributeValueInformation
    - `id` string, uuid — The attribute option GUID.
    - `value` string — The attribute option value.
    - `valueKey` string — The attribute option value key for translation.
    - `colorCode` string — The attribute option color code.
    - `optionSelectionValue` string — The attribute option selection value.
  - `exportType` 'Consent Receipts' | 'Cookie Receipts' | 'Data Subjects' — The type of data to export.
  - `fileFormat` 'csv' | 'json' — The file format of the bulk export.
  - `completionDate` string, date-time — The date and time that the bulk export was completed.
  - `expiryDate` string, date-time — The date and time that the bulk export file expires.
  - `progressPercentage` number, double — The percent progress of completion for the bulk export.
  - `availableCredit` integer — The number of remaining bulk exports for the account.
  - `recordCount` integer — The total number of records included within the bulk export.
  - `startDate` string, date — The start of a date range used to filter results.
  - `endDate` string, date — The end of a date range used to filter results.
  - `params` BulkExportParam[] — The parameters used to filter results.
    - union
      - object
        - `name` 'collectionPointGuid', required — This parameter filters results by a specific collection point ID.
        - `values` string[] — The unique identifier of the collection point.
      - object
        - `name` 'purposeGuid', required — This parameter filters results by purpose IDs.
        - `values` string[] — The unique identifier of a purpose. Minimum 1 item, maximum 20 values.
      - object
        - `name` 'lastTransactionCollectionPointId', required — This parameter filters results for data subjects that have last given consent from the specific collection point.
        - `values` string[] — The unique identifier of a collection point that recorded a data subject's last transaction. Minimum 1 item, maximum 20 values.
      - object
        - `name` 'purposeId', required — This parameter filters results by purpose IDs.
        - `values` string[] — The unique identifier of a purpose.
      - object
        - `name` 'status', required — This parameter filters results by the consent status. For more information, see [Data Subject Purpose Statuses.](https://my.onetrust.com/s/article/UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f?language=en_US#UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f_section-idm46212287084304)
        - `values` string[] — The status of consent. Minimum 1 item, maximum 20 values.
      - object
        - `name` 'customPreferenceName', required — This parameter filters results by custom preference names.
        - `values` string[] — The name of the custom preference. If the custom preference name is included without the custom preference value, the export will return all records with the custom preference.
      - object
        - `name` 'customPreferenceValue', required — This parameter filters results by the custom preference value.
        - `values` string[] — The value of the custom preference. This parameter must be used in conjunction with the custom preference name. The export will return all records with the custom preference and the specific value.
      - object
        - `name` 'dataElementName', required — This parameter filters results by data element names.
        - `values` string[] — The name of the data element. If the data element name is included without the data element value, the export will return all records with the data element.
      - object
        - `name` 'dataElementValue', required — This parameter filters results by data element values.
        - `values` string[] — The value of the data element. This parameter must be used in conjunction with the data element name. The export will return all records with the data element and the specific value.
      - object
        - `name` 'withdrawalNotes', required — This parameter filters results by withdrawal notes.
        - `values` string[] — The reason notes that explain why consent was withdrawn.
      - object
        - `name` 'includeTestDataSubject', required — This parameter filters results by test data subjects.
        - `values` string[] — This flag indicates whether to include or exclude test data subjects. This parameter defaults to false (i.e. no test data subjects will be returned). Exactly 1 item is required.
      - object
        - `name` 'dateType', required — This parameter filters results by various dates recorded for a data subject.
        - `values` string[] — The type of date that the `startDate` and `endDate` reference to filter results. The `CREATED_DATE` value filters results by data subjects' `FirstTransactionDate`. The `LAST_MODIFIED_DATE` value filters results by data subjects' `LastTransactionDate`. The `LAST_INTERACTION_DATE` value filters results by data subjects' `LastInteractionDate`. This parameter defaults to `CREATED_DATE`. Exactly 1 selection is required.
      - object
        - `name` 'primaryIdentifierType', required — This parameter filters results by a specific identifier type for the primary identifier, such as email.
        - `values` string[] — The type of data subject identifier used as a primary identifier.
      - object
        - `name` 'additionalIdentifierType', required — This parameter filters results by a specific identifier type, such as email.
        - `values` string[] — The type of data subject identifier used as an additional identifier.
      - object
        - `name` 'organizationGroupId', required — This parameter filters results by organization IDs.
        - `values` string[] — The unique identifier of the organization. Records assigned to the organization and any child organizations below it will be returned.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/revisions/21de3aa0b170/schema)