---
title: "Get List of Bulk Exports"
method: GET
path: "/api/ot-insights/v1/bulk-export-jobs"
tags: ["Bulk Export"]
---

# Get List of Bulk Exports

`GET /api/ot-insights/v1/bulk-export-jobs`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/ot-insights/v1/bulk-export-jobs`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `BULK_EXPORT`

Use this API to retrieve a list of bulk exports. The response will include the created date, ID, and status of each export.

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

## Query parameters

- `page` integer: Results page to be retrieved (0..N). Example- '?page=1'
- `size` integer: Number of records per page (1..2000). Example- '?size=30'
- `sort` 'name,asc' | 'name,desc' | 'status,asc' | 'status,desc' | 'createdDate,asc' | 'createdDate,desc' | 'completedDate,asc' | 'completedDate,desc' | 'expiryDate,asc' | 'expiryDate,desc': The sort criteria that dictates the order of the results.

## Response `200`

OK

- PageBulkExportListItem
  - `content` BulkExportListItem[]: The data of the returned objects.
    - `runId` string, uuid: The unique identifier of 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 unique identifier of the user who initiated the bulk export.
      - `value` string: The name of the user who initiated the bulk export.
      - `valueKey` string: This value will always be null.
      - `colorCode` string: The attribute option color code.
      - `optionSelectionValue` string: The attribute option selection value.
      - `displayLabel` string: The display label for the option value.
      - `disabled` boolean: This flag indicates whether the user is inactive.
    - `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.
    - `organizationGroupId` string, uuid: The organization ID associated with the bulk export.
  - `pageable` PageableObject
    - `offset` integer: The number of results to exclude from the start of the list.
    - `sort` SortObject
      - `empty` boolean: This flag indicates whether sort criteria was left undefined.
      - `sorted` boolean: This flag indicates whether the results were sorted.
      - `unsorted` boolean: This flag indicates whether the results were not sorted.
    - `paged` boolean: This flag indicates whether the results were paged.
    - `pageSize` integer: The number of results per page.
    - `pageNumber` integer: The page number of the results.
    - `unpaged` boolean: This flag indicates whether the results were not paged.
  - `last` boolean: This flag indicates whether the current page is the last page of the list.
  - `totalElements` integer: The total number of results in the list.
  - `totalPages` integer: The total number of pages in the list.
  - `size` integer: The number of results per page.
  - `number` integer: The page number of the results.
  - `sort` SortObject
    - `empty` boolean: This flag indicates whether sort criteria was left undefined.
    - `sorted` boolean: This flag indicates whether the results were sorted.
    - `unsorted` boolean: This flag indicates whether the results were not sorted.
  - `first` boolean: This flag indicates whether the current page is the first page of the list.
  - `numberOfElements` integer: The number of results on the current page.
  - `empty` boolean: This flag indicates whether no results exist on the page.

## 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.dev/onetrust/apis/platform-bulk-export.md) - [All operations](https://skmtc.dev/onetrust/apis/platform-bulk-export/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/platform-bulk-export/revisions/ace6a8a3116d?raw)