myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS

Get Optimized List of All Purpose Details for All Data Subjects

get
https://{hostname}/rest/api/consent/v4/datasubjects/profiles/unordered

Use this API to retrieve an unordered 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
  • This API is optimized for high-performance bulk retrieval where sorting is not required. Results are not returned in a specific order and may appear random. Bookmarking is supported for consistent pagination.
  • This API has more flexible rate limits compared to the standard Get List of All Purpose Details for All Data Subjects API.
Query Params
uuid

The unique identifier for a Collection Point.

uuid

The unique identifier for a Purpose.

string
enum

The status of the Purpose for the data subject.

date-time
required

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

date-time
required

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

integer
≥ 0
Defaults to 0

The page number of the results.

integer
1 to 50
Defaults to 20

The number of results per page.

Headers
string

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

Responses

400

Bad Request

500

Internal Server Error

Updated about 1 month ago

Language
Credentials
OAuth2
Missing 2 required scopes
URL
LoadingLoading…
Response
Choose an example:
application/json
*/*

Updated about 1 month ago