Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Subjects V4

Get List of All Purpose Details for All Data Subjects

Use this API to retrieve a list of all purpose details last updated between a specified date range for all data subjects.

🗒 Things to Know

  • The maximum date range that can be returned is 30 days.
  • Along with the mandatory date range filter parameters, this API supports the following filter combinations:
    • collectionPointId, purposeId, and status
    • purposeId and status
    • collectionPointId
get/rest/api/consent/v4/datasubjects/profiles

Query parameters

collectionPointIdstring uuid

The unique identifier of the collection point.

purposeIdstring uuid

The unique identifier of the purpose.

status'EXPIRED' | 'WITHDRAWN' | 'NO_CONSENT' | 'PENDING' | 'ACTIVE' | 'OPT_OUT' | 'ALWAYS_ACTIVE' | 'HARD_OPT_OUT' | 'EXTEND' | 'CHANGE_PREFERENCES' | 'NOT_OPT_OUT' | 'OPT_IN' | 'IMPLICIT'

The status of the purpose for the data subject.

updatedSincestring date-time required

The start of a date and time range used to filter results.

updatedUntilstring date-time required

The end of a date and time range used to filter results.

pageinteger

The page number of the results.

sizeinteger

The number of results per page.

sort'lastUpdatedDate,asc' | 'lastUpdatedDate,desc'

The sort criteria that dictates the order of the results.

Headers

requestContinuationstring

The token used to paginate a response if the number of records is more than a page.

Response

OK

numberinteger

The page number of the results.

sizeinteger

The number of results per page.

lastboolean

Flag indicating whether this is the last page or not.

firstboolean
numberOfElementsinteger
emptyboolean
requestContinuationstring

The token used to paginate a response if the number of records is more than a page.

Example response

{
  "content": [
    {
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "identifier": "example@otprivacy.com",
      "lastReceiptId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "name": "Marketing Communications",
      "version": 2,
      "status": "ACTIVE",
      "firstTransactionDate": "2020-01-05T11:34:30.974Z",
      "lastTransactionDate": "2020-01-12T16:11:25.479Z",
      "withdrawalDate": "2020-01-12T16:11:25.479Z",
      "consentDate": "2020-01-07T13:18:23.123Z",
      "expiryDate": "2020-01-07T13:18:23.123Z",
      "totalTransactionCount": 3,
      "topics": [
        {
          "id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
          "name": "Car Marketing"
        }
      ],
      "customPreferences": [
        {
          "id": "c4a57a38-3774-45ad-9fa4-dbc545542232",
          "name": "Email Frequency",
          "options": [
            {
              "id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
              "name": "Weekly"
            }
          ]
        }
      ],
      "purposeNote": {
        "noteId": "f312dd9b-58b4-4f34-b5ff-10b9b464bc4f",
        "noteType": "UNSUBSCRIBE_REASON",
        "noteLanguage": "en-us",
        "noteText": "I did not sign up for this.",
        "isValidNote": true
      },
      "lastUpdatedDate": "2020-01-05T11:34:30.974Z",
      "lastInteractionDate": "2020-01-05T11:34:30.974Z",
      "geolocation": {
        "dataSubjectId": "633ba071-61b0-485f-81a0-a2245777b432",
        "receiptGuid": "633ba071-61b0-485f-81a0-a2245777b432",
        "country": "US",
        "state": "GA",
        "stateName": "Georgia"
      },
      "attachments": [
        {
          "attachmentId": "25d9ccac-db88-4d34-849c-3d602a629961",
          "fileName": "policy.pdf",
          "uploadedBy": "John Doe",
          "uploadDate": "2024-01-01T00:00:00"
        }
      ],
      "source": {
        "dataSubjectId": "633ba071-61b0-485f-81a0-a2245777b432",
        "receiptGuid": "633ba071-61b0-485f-81a0-a2245777b432",
        "sourceType": "WEB",
        "sourceContent": "https://example.com/consent"
      }
    }
  ],
  "number": 1,
  "size": 20,
  "requestContinuation": "{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"
}