---
title: "Get List of Receipt Details by Data Subject"
method: GET
path: "/api/consentmanager/v1/receipts"
tags: ["Receipts"]
---

# Get List of Receipt Details by Data Subject

`GET /api/consentmanager/v1/receipts`

> ❗️ End of Support Notification
> 
> As of September 1, 2024, these APIs are now deprecated. Any customers leveraging these APIs are encouraged to migrate to the [Receipts V2 API](https://developer.onetrust.com/onetrust/reference/getreceiptlistdetailsusingpost). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).

Use this API to retrieve a list of consent receipts for a given data subject along with details such as the associated Purposes, Purpose Preferences, and attributes. The response will also include relevant information about the latest Collection Point interactions and the current status of consent.

## Query parameters

- `includeNotgiven` boolean
- `page` integer
- `size` integer

## Headers

- `identifier` string, required

## Response `200`

OK - Successfully retrieved receipt details.

- ConsentPreferencesUniversalConsentPreferenceManagReceiptInformationDetailSliceDto
  - `content` ConsentPreferencesUniversalConsentPreferenceManagReceiptInformationDetailDto[]
    - `id` string, uuid, required — The unique identifier for the receipt
    - `otJwtVersion` integer — Version of the JWT token used for the receipt
    - `dataSubjectIdentifierHash` string — Hashed value of the data subject's identifier for privacy protection
    - `dataSubjectIdentifier` string — The actual identifier of the data subject (e.g., email, user ID)
    - `collectionPointUUID` string, uuid — Unique identifier of the collection point that generated this receipt
    - `collectionPointVersion` integer — Version number of the collection point
    - `collectionPointName` string — Human-readable name of the collection point
    - `consentCreationDate` string, date-time — Timestamp when the consent was created
    - `receiptJwt` string, required — JWT token containing the receipt information
    - `customPayload` string — Custom JSON payload included with the receipt
    - `purposes` ConsentPreferencesUniversalConsentPreferenceManagPurposeInformationDtoV2[] — List of purposes associated with this receipt
      - `id` string, uuid — Unique identifier of the purpose
      - `name` string — Name of the purpose
      - `description` string — Detailed description of the purpose's data processing activities
      - `status` 'DRAFT' | 'ACTIVE' | 'RETIRED' — Current status of the purpose
      - `version` integer — Version number of the purpose
      - `purposeType` 'STANDARD' | 'COOKIE' | 'IAB' | 'MOBILE' | 'NOTIFICATION_OPT_OUT' — Classification type of the purpose
      - `consentLifeSpan` integer — Duration in seconds that consents for this purpose remain valid
      - `transactionType` 'PENDING' | 'CONFIRMED' | 'WITHDRAWN' | 'EXPIRED' | 'NOTGIVEN' | 'OPT_OUT' | 'NO_CHOICE' | 'HARD_OPT_OUT' | 'EXTEND' | 'CHANGE_PREFERENCES' | 'OPT_IN' | 'NO_OPT_OUT' | 'CANCEL' | 'IMPLICIT' — Type of transaction associated with the purpose
      - `topics` ConsentPreferencesUniversalConsentPreferenceManagPurposeTopicDtoV2[] — List of topics associated with this purpose
        - `id` string, uuid, required — Unique identifier of the purpose-topic relationship
        - `transactionType` string — Type of transaction associated with the topic
        - `name` string, required — Name of the topic
        - `integrationKey` string — Integration key formed by combining purpose and topic names
        - `languages` ConsentPreferencesUniversalConsentPreferenceManagTopicLanguageDtoV2[] — List of language-specific content for the topic
          - `name` string
          - `language` string
          - `default` boolean
        - `canDelete` boolean — Indicates whether this topic can be deleted
      - `purposeAttachments` ConsentPreferencesUniversalConsentPreferenceManagDsAttachments[] — List of file attachments or documents associated with the purpose
        - `id` string, uuid
      - `purposeScopes` ConsentPreferencesUniversalConsentPreferenceManagDsPurposeScope[] — List of scopes or contexts where this purpose applies
        - `key` string
        - `value` string
      - `customPreferences` ConsentPreferencesUniversalConsentPreferenceManagPurposeCustomPreferenceDtoV2[] — List of custom preferences associated with this purpose
        - `id` string, required — Unique identifier of the purpose-custom preference relationship
        - `name` string, required — Name of the custom preference
        - `displayAs` 'BUTTONS' | 'CHECKBOXES', required — Display type for rendering the custom preference in the UI
        - `customPreferenceOptions` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceOptionDtoV2[] — List of available options for this custom preference
          - `id` string
          - `transactionType` string
          - `label` string
          - `order` integer
          - `isDefault` boolean
        - `languages` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceLanguageDtoV2[] — List of language-specific content for the custom preference
          - `name` string
          - `description` string
          - `language` string
          - `default` boolean
          - `options` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceOptionDtoV2[]
            - `id` string
            - `transactionType` string
            - `label` string
            - `order` integer
            - `isDefault` boolean
      - `purposeNote` ConsentPreferencesUniversalConsentPreferenceManagPurposeNoteDtoV2
        - `noteId` string, uuid — Unique identifier of the reason template
        - `noteType` 'UNSUBSCRIBE_REASON' — The type of the note
        - `noteLanguage` string — The language of the note
        - `noteText` string — The actual text of the note
        - `isValidNote` boolean — Flag indicating if the note is a valid reason template
      - `attributes` object — Key-value pairs of custom attributes associated with the purpose
    - `test` boolean — Indicates if this receipt was created in test mode
    - `origin` 'IMPORT' | 'API' | 'SDK' | 'ONETRUST' | 'PREFERENCE_CENTER' | 'EMAIL_CLIENT_ONE_CLICK' | 'HISTORIC_IMPORT' — Source origin of the consent request
    - `doubleOptIn` boolean — Indicates if double opt-in was required for this consent
    - `language` string — Language code for the consent interaction
    - `collectionPointType` string — Type of the collection point
    - `isAnonymous` boolean — Indicates if the consent was given anonymously
    - `attributes` object — Additional attributes associated with the receipt
    - `interactionDate` string, date-time — Timestamp of the user interaction that generated this receipt
    - `dsDataElements` object — Data subject related data elements
    - `unsubscribeAll` boolean — Indicates if the user opted to unsubscribe from all communications
    - `attachments` ConsentPreferencesUniversalConsentPreferenceManagDsAttachments[] — List of attachments associated with the receipt
      - `id` string, uuid
    - `additionalIdentifiers` object — Additional identifiers for the data subject
    - `geolocation` ConsentPreferencesUniversalConsentPreferenceManagDsGeolocation
      - `country` string — Country of the DataSubject
      - `state` string — State Code of the DataSubject
      - `stateName` string — State Name of the DataSubject
      - `purposeIds` string[] — List of Unique Identifiers of the Purpose for which Geolocation parameters are sent
    - `ruleEvaluationResults` ConsentPreferencesUniversalConsentPreferenceManagRuleEvaluationResult[] — Results of any rules evaluated during consent processing
      - `ruleId` string, uuid
      - `ruleGroupId` string, uuid
      - `consentRuleType` 'CONSENT_INGEST'
      - `evaluationResult` boolean
      - `actionResults` ConsentPreferencesUniversalConsentPreferenceManagRuleActionResult[]
        - `ruleAction` string
        - `ruleActionParameter` string
        - `ruleActionStatus` 'COMPLETED' | 'PARTIALLY_COMPLETED' | 'NOT_INITIATED' | 'FAILED'
        - `downStreamRuleActions` ConsentPreferencesUniversalConsentPreferenceManagDownStreamRuleAction[]
          - `actionType` 'SEND_EMAIL' | 'DATA_SUBJECT_UPDATE' | 'DATA_SUBJECT_PROFILE_UPDATE' | 'PUBLISH_INTEGRATION_EVENT'
          - `ruleAction` string
          - `ruleActionParameter` string
      - `resultData` object[]
      - `additionalParams` object
    - `consentStringDto` ConsentPreferencesUniversalConsentPreferenceManagConsentStringDto
      - `type` string — Type of the consent string (e.g., IAB_TCF_V2, ONETRUST)
      - `content` string — The actual consent string content (base64 encoded string)
    - `source` ConsentPreferencesUniversalConsentPreferenceManagSourceDto
      - `type` string — Type of the source (e.g., 'WEB', 'MOBILE_APP', 'API')
      - `content` string — Content or identifier from the source system
      - `purposeIds` string[] — List of purpose IDs associated with this source
  - `number` integer — The page number of the results.
  - `size` integer — The number of results per page.
  - `pageable` ConsentPreferencesUniversalConsentPreferenceManagPageableObject
    - `offset` integer
    - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObject
      - `empty` boolean
      - `unsorted` boolean
      - `sorted` boolean
    - `pageNumber` integer
    - `pageSize` integer
    - `paged` boolean
    - `unpaged` boolean
  - `last` boolean — Flag indicating whether this is the last page or not.
  - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObject
    - `empty` boolean
    - `unsorted` boolean
    - `sorted` boolean
  - `first` boolean
  - `numberOfElements` integer
  - `empty` boolean

## 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/versions/21de3aa0b170/schema)