Get List of Data Subjects

get

https://{hostname}/rest/api/consent/v4/datasubjects

Use this API to retrieve a list of data subjects that were last updated between the specified date range. The response will include basic details, such as each data subject’s identifier, created date, data elements, and last updated date.

🗒
Things to Know

The maximum date range that can be returned is 7 days.

Query Params

fromDate

date-time

required

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

toDate

date-time

required

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

isDNCInclude

boolean

Defaults to false

Indicates whether to include data subject in the response if the data subject is in the DNC list.

page

integer

≥ 0

Defaults to 0

The page number of the results.

size

integer

1 to 50

Defaults to 20

The number of results per page.

sort

string

enum

Defaults to lastModifiedDate,desc

The sort criteria that dictates the order of the results.

Allowed:

Headers

requestContinuation

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

200OK

401Unauthorized

403Forbidden

404Not Found

429Too Many Requests. For more information, see API Rate Limits.