v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Magic Link Tokens V4

Get List of Data Subject Tokens

Use this API to retrieve a list of link tokens created between a specified date range for all data subjects.

🗒 Things to Know

  • The maximum date range that can be returned is 7 days.
get/rest/api/consent/v4/linktokens

Query parameters

fromDatestring date-time required

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

toDatestring 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'expiryDate,asc' | 'expiryDate,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

List of Email Link Tokens retrieved successfully.

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": [
    {
      "token": "QFpXYCFOYUrFZfstplM5l1hjdLv4YlaQtkbYt7gpZUc=",
      "identifier": "example@otprivacy.com",
      "createdDate": "2024-01-01T00:00:00.000",
      "expiryDate": "2024-02-01T00:00:00.000"
    }
  ],
  "number": 1,
  "size": 20,
  "requestContinuation": "{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"
}