Get Data Subject

❗️

Migration Recommendation

Please, do not adopt this API if you have not already done so. Continue to use the Get List of Data Subjects V1 API or request access to have Data Subjects V4 APIs enabled.

Use this API to retrieve a single data subject using the identifer header parameter.

🗒

Things to Know

  • This API can also be used to retrieve the magic link token as linkToken in the response.
  • This API will remain available during maintenance periods.
  • This API is not designed to be used in workflows.
Recipes
📥
Creating a Collection Point and Retrieving Consent
Open Recipe
Query Params
boolean

Includes the data subject's instant link token in the response that is used to login to the preference center.

boolean

Includes whether the data subject's phone numbers are on the FTC Do Not Call registry or not.

Headers
string

Data subject to return details for. Example- johndoe@onetrust.com

Responses

401

Unauthorized

403

Forbidden

404

Not found

Language
Credentials
OAuth2