Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Persons

Get a person's consent history

Gets a paged collection of events indicating when a person granted/denied consent to have their personal data stored (required scope contacts:persons:read)

get/v1/persons/{personId}/dataConsent/history

Path parameters

personIdstring uuid required

The unique identifier of the person

Query parameters

direction'ascending' | 'descending'

Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>

Example:ascending

The direction to apply the sort

sortBy'createdAt'

Sort options for Person Consent<p>Possible values:</p><ul><li><b>createdAt</b>: Sort by Creation Date</li></ul>

Example:createdAt

The field to sort items in the page by

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 12345,
      "createdAt": "2022-11-29T16:50:16.0000000+00:00",
      "status": "awaiting",
      "medium": "email",
      "comment": "Happy for their data to be held."
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}