--- title: "Create Bulk Export" method: POST path: "/api/ot-insights/v1/bulk-export-jobs" tags: ["Bulk Export"] --- # Create Bulk Export `POST /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 create a bulk export based on the specified criteria. > 🗒 Things to Know > > - `COOKIE_RECEIPTS` exports are currently under Public Preview. Please contact OneTrust Support to request early access before running the export. > - All historic data is not available by default. `COOKIE_RECEIPTS` exports will become available once the feature is enabled. `CONSENT_RECEIPTS` exports are available from the OneTrust 202407.1.0 release or earlier if you had requested the feature while it was in preview. > > #### Usage Guidelines > > - **Bulk Export Limits & Lifecycle:** > - Each account is limited to 20 bulk exports per month. If you cancel a bulk export before it completes, it will not be counted towards this limit. To increase your export limit, contact OneTrust Support. > - The status of a bulk export will automatically change to `Expired` 10 days after its creation. > - **Data Volume & File Constraints:** > - The maximum limit allowed is 1 million records, which is equivalent to approximately 8MB for `COOKIE_RECEIPTS` and `CONSENT_RECEIPTS` exports. > - For bulk exports less than 1 million records, we recommend using a report to pull the list. As it cannot be guaranteed that the bulk export reaches this maximum, the results will be split across multiple files up to 1 million records. > - **Date & Time Constraints:** > - The timespan for the `endDate` - `startDate` is limited to 180 days when the `exportType` is `CONSENT_RECEIPTS` OR `COOKIE_RECEIPTS` and 30 days when it's `ANONYMOUS_RECEIPTS`. > - The `endDate` can be as recent as yesterday, but cannot be the current day. > - If a value is not provided for the `dateType` parameter in `DATA_SUBJECTS` exports, this value will be set to `CREATED_DATE` by default. > - **Filtering:** > - `CONSENT_RECEIPTS` and `COOKIE_RECEIPTS` only support filtering based on either `collectionPointGuid` or `purposeGuid`. Both cannot be used at the same time. > - Bulk export filters are case-sensitive. > - **Additional Information:** > - For `DATA_SUBJECTS` exports, only data subjects with a recorded consent transaction will be included. > - For `DATA_SUBJECTS_BULK_ACTIONS` exports, select `CSV` as the `exportFormat` for a compatible output with the Consent data subjects bulk actions import template in the OneTrust Platform. Once imported, related receipts will be deleted. ```json Consent Receipts with Collection Point Filter { "exportType": "CONSENT_RECEIPTS", "startDate": "2023-07-01", "endDate": "2023-12-01", "params": [ { "name": "collectionPointGuid", "values": [ "af01cad5-a39d-4585-9ee1-2062b1426bdd" ] } ] } ``` ```json Cookie Receipts with Purpose Filter { "exportType": "COOKIE_RECEIPTS", "startDate": "2023-11-01", "endDate": "2023-12-01", "params": [ { "name": "purposeGuid", "values": [ "af01cad5-a39d-4585-9ee1-2062b1426bdd" ] } ] } ``` ```json Data Subjects with Filters { "exportType": "DATA_SUBJECTS", "startDate": "2024-01-01", "endDate": "2024-06-01", "params": [ { "name": "lastTransactionCollectionPointId", "values": [ "c0431f94-664b-431e-bff3-3b341571c2af" ] }, { "name": "purposeId", "values": [ "514780d1-7797-4952-84e7-d6c70b018fed", "fb1ec920-68cd-4c9a-99da-77b21bd5b9d5", "55ede8d8-0aab-40b8-a6b7-6c5221b62aa7" ] }, { "name": "status", "values": [ "ACTIVE" ] }, { "name": "dataElementName", "values":[ "FirstName" ] }, { "name": "dataElementValue", "values":[ "George" ] } ] } ``` ## Request body - union - object - `name` string: The name of the bulk export. - `exportType` 'CONSENT_RECEIPTS', required: The type of data to export. - `startDate` string, date, required: The start of a date range used to filter results. This parameter is required for the `CONSENT_RECEIPTS` export type, and the timespan is limited to 180 days. - `endDate` string, date, required: The end of a date range used to filter results. This parameter is required for the `CONSENT_RECEIPTS` export type and must be within 180 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day. - `exportFormat` 'CSV' | 'JSON' - `params` ConsentReceiptsParamSchema[]: The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object. - union - object - `name` 'collectionPointType': This parameter filters results by collection point types. - `values` string[]: The type of collection point. - object - `name` 'collectionPointVersion', required: This parameter filters results by collection point versions. - `values` integer[]: The version of the collection point. - 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` 'purposeVersion', required: This parameter filters results by purpose versions. - `values` integer[]: The version of the purpose. Minimum 1 item, maximum 20 values. - 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` string: The name of the bulk export. - `exportType` 'COOKIE_RECEIPTS', required: The type of data to export. - `startDate` string, date, required: The start of a date range used to filter results. This parameter is required for the `COOKIE_RECEIPTS` export type, and the timespan is limited to 180 days. - `endDate` string, date, required: The end of a date range used to filter results. This parameter is required for the `COOKIE_RECEIPTS` export type and must be within 180 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day. - `exportFormat` 'CSV' | 'JSON' - `params` CookieReceiptsParamSchema[]: The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object. - union - object - `name` 'collectionPointVersion', required: This parameter filters results by collection point versions. - `values` integer[]: The version of the collection point. - 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` 'purposeVersion', required: This parameter filters results by purpose versions. - `values` integer[]: The version of the purpose. Minimum 1 item, maximum 20 values. - 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` string: The name of the bulk export. - `exportType` 'ANONYMOUS_RECEIPTS', required: The type of data to export. - `startDate` string, date, required: The start of a date range used to filter results. This parameter is required for the `ANONYMOUS_RECEIPTS` export type. - `endDate` string, date, required: The end of a date range used to filter results. This parameter is required for the `ANONYMOUS_RECEIPTS` export type and must be within 30 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day. - `exportFormat` 'CSV' | 'JSON' - `params` AnonymousReceiptsParamSchema[]: The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object. - union - object - `name` 'collectionPointVersion', required: This parameter filters results by collection point versions. - `values` integer[]: The version of the collection point. - 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` 'purposeVersion', required: This parameter filters results by purpose versions. - `values` integer[]: The version of the purpose. Minimum 1 item, maximum 20 values. - 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` string: The name of the bulk export. - `exportType` 'DATA_SUBJECTS', required: The type of data to export. - `startDate` string, date, required: The start of a date range used to filter results. This parameter is required for the `DATA_SUBJECTS` export type, and the timespan is limited to 180 days. - `endDate` string, date, required: The end of a date range used to filter results. This parameter is required for the `DATA_SUBJECTS` export type and must be within 180 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day. - `exportFormat` 'CSV' | 'JSON' - `params` DataSubjectsParamSchema[]: The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object. - union - 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. - object - `name` string: The name of the bulk export. - `exportType` 'DATA_SUBJECTS_BULK_ACTIONS', required: The type of data to export. - `startDate` string, date: The start of a date range used to filter results. This parameter is optional for the `DATA_SUBJECTS_BULK_ACTIONS` export type. - `endDate` string, date: The end of a date range used to filter results. This parameter is optional for the `DATA_SUBJECTS_BULK_ACTIONS` export type. - `exportFormat` 'CSV' | 'JSON' - `params` DataSubjectsBulkActionsParamSchema[]: The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object. - union - object - `name` 'actionType', required: This parameter filters results by the bulk action type. - `values` string[]: The bulk action type. Exactly 1 item is required. This is a mandatory filter. - object - `name` 'testDataSubject', required: This parameter filters results by test data subjects. - `values` string[]: This flag indicates whether to include or exclude test data subjects. 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` '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. - object - `name` 'purposeId', required: This parameter filters results by purpose IDs. - `values` string[]: The unique identifier of a purpose. - 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` 'withdrawalNotes', required: This parameter filters results by withdrawal notes. - `values` string[]: The reason notes that explain why consent was withdrawn. - 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` '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` 'newIdentifierType', required: The name of the parameter used to specify the new identifier type. - `values` string[]: The new identifier type. Exactly 1 item is required when the `actionType` is `CHANGE_IDENTIFIER_TYPE`. - object - `name` string: The name of the bulk export. - `exportType` 'DATA_SUBJECTS_BULK_ADD_PURPOSE', required: The type of data to export. - `startDate` string, date, required: The start of a date range used to filter results. This parameter is required for the `DATA_SUBJECTS_BULK_ADD_PURPOSE` export type, and the timespan is limited to 180 days. - `endDate` string, date, required: The end of a date range used to filter results. This parameter is required for the `DATA_SUBJECTS_BULK_ADD_PURPOSE` export type and must be within 180 days from the `startDate`. The `endDate` can be as recent as yesterday, but cannot be the current day. - `exportFormat` 'CSV' | 'JSON' - `params` DataSubjectsBulkAddPurposeParamSchema[]: The parameters used to filter results. To define multiple parameters, click the Add Object option that appears below the first object. - union - 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. - object - `name` 'sourcePurposeGuid', required: This parameter filters results by the source purpose GUID. - `values` string[]: The source purpose GUID from which to copy status. Exactly 1 item is required. - object - `name` 'targetPurposeGuid', required: This parameter filters results by the target purpose GUID. - `values` string[]: The target purpose GUID to which to copy status. Exactly 1 item is required. - object - `name` 'defaultStatus', required: This parameter filters results by the target purpose status when the source purpose status is not found. - `values` string[]: The target purpose status when the source purpose is not found. Exactly 1 item is required. - object - `name` 'collectionPointJWT', required: This parameter filters results by the collection point JWT. - `values` string[]: The collection point JWT to use for bulk import. Exactly 1 item is required. - object - `name` string: The name of the bulk export. - `exportType` 'DATA_ELEMENT_BULK_ACTIONS', required: The type of data to export. - `startDate` string, date: The start of a date range used to filter results. This parameter is optional for `DATA_ELEMENT_BULK_ACTIONS` export type and is rejected when actionType is `DELETE_DS_ELEMENT`. - `endDate` string, date: The end of a date range used to filter results. This field is optional for DATA_ELEMENT_BULK_ACTIONS export type and is rejected when actionType is DELETE_DS_ELEMENT. - `exportFormat` 'CSV' | 'JSON' - `params` DataElementBulkActionsParamSchema[] - union - object - `name` 'actionType', required: The name of the parameter used to specify the bulk action type. Exactly 1 item required. This is a mandatory filter. - `values` string[] - 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` 'newOptionValue', required: The name of the parameter used to specify the new option value. Exactly 1 item required when actionType is UPDATE_OPTION; rejected when actionType is DELETE_DS_ELEMENT. - `values` string[] - object - `name` 'testDataSubject', required: This parameter filters results by test data subjects. - `values` string[]: This flag indicates whether to include or exclude test data subjects. 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` '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. ## 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 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. - `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` 'collectionPointType': This parameter filters results by collection point types. - `values` string[]: The type of collection point. - 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.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)