Sign in
Magic Link Tokens

Get List of Data Subject Tokens

Use this API to retrieve a list of link tokens. The response will return link tokens along with the corresponding data subject ID, created date, and expiry date. By default, the response will return link token details sorted in ascending order of created date.

get/api/consentmanager/v1/linktokens

Query parameters

sincestring date-time
Example:2023-01-01T00:00:00

Date from which to return records. Formats accepted yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

untilstring date-time
Example:2023-12-31T23:59:59

Date to which to return records. Formats accepted yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

pageinteger

Results page you want to retrieve (0..N).

sizeinteger
Example:20

Number of records per page.

sort'id,asc' | 'id,desc' | 'tokenId,asc' | 'tokenId,desc' | 'expiryDate,asc' | 'expiryDate,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'createdBy,asc' | 'createdBy,desc' | 'lastModifiedBy,asc' | 'lastModifiedBy,desc' | 'dataSubject.guid,asc' | 'dataSubject.guid,desc' | 'dataSubject.identifier,asc' | 'dataSubject.identifier,desc'
Example:createdDate,desc

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Headers

identifierstring
Example:user@example.com

Identifier of the Data Subject for which you want to retrieve the Email Link Token.

Response

OK - Successfully retrieved link tokens.

emptyboolean

The flag to check if the entity is empty or not.

firstboolean

The flag to check if the entity is first entity or not.

lastboolean

The flag to check if the entity is last entity or not.

numberinteger

The number associated with the result.

numberOfElementsinteger

Total number of elements in the result.

totalPagesinteger

Total number of pages in the result list.

totalElementsinteger

Total number of elements in the result.

sizeinteger

Size of the result list.

Example response

{
  "content": [
    {
      "DataSubjectId": "example@otprivacy.com",
      "LinkToken": "jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ=",
      "UrlEncodedLinkToken": "jNJW2e8vm8eWb6DlWyGbZ%2F7PsfC%2BAHFN8JqvZHPGzJQ%3D",
      "ExpiryDate": "2023-12-31T23:59:59.999Z",
      "CreatedDate": "2023-01-01T00:00:00Z"
    }
  ],
  "first": true,
  "numberOfElements": 20,
  "totalPages": 5,
  "totalElements": 50,
  "size": 20
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.