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)
Path Parameters
The unique identifier of the person
Query Parameters
Possible values: [ascending, descending]
The direction to apply the sort
Possible values: [createdAt]
The field to sort items in the page by
Possible values: >= 1 and <= 2147483
The page number being requested (minimum: 1, maximum: 2147483)
Possible values: >= 1 and <= 1000
The page size being requested (minimum: 1, maximum: 1000)
Header Parameters
The customer identifier
- 200
- 400
- 403
- 404
- 500
Success
Schema
- Array [
- awaiting: Awaiting
- refused: Refused
- granted: Granted
- email: Email
- click: Click
- telephone: Telephone
- ]
items object[]
The items returned for the requested page
The unique identifier of the consent preference
The UTC timestamp of when this preference was captured
Possible values: [awaiting, refused, granted]
The consent preference indicated by the person
Possible values:
Possible values: [email, click, telephone]
The medium that a person has expressed their consent using
Possible values:
Descriptive text about how and/or why the person has made this consent decision
The page number of the response where 1 is the first page
The number of items requested for the current page
The number of items returned in the current page
{
"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
}
Bad Request
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Forbidden
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Not Found
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Server Error
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}