GET request/n3rgy/consent/user/list
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of UserConsentsList| Name | Description | Type | Additional information |
|---|---|---|---|
| Address | Address |
None. |
|
| Consents | Collection of Consent |
None. |
|
| ConsentUserGuid | globally unique identifier |
None. |
|
| ConsentUserId | integer |
None. |
|
| string |
None. |
||
| MoveInDate | date |
None. |
|
| Name | string |
None. |
|
| ReferralBranchCode | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"consentUserId": 1,
"consentUserGuid": "e597f81b-ce73-44c1-a8c9-6f680b0b795a",
"referralBranchCode": "sample string 3",
"name": "sample string 4",
"address": {
"city": "sample string 1",
"country": "sample string 2",
"line1": "sample string 3",
"line2": "sample string 4",
"postcode": "sample string 5",
"county": "sample string 6"
},
"email": "sample string 5",
"consents": [
{
"consentId": 1,
"mpxn": "sample string 2",
"consentReferenceId": "sample string 3",
"evidencePath": "sample string 4",
"statusId": 64,
"consentTypeId": 64,
"withdrawRequestTimestamp": "2026-01-29T02:51:56.1248468+00:00",
"withdrawExecutionTimestamp": "2026-01-29T02:51:56.1248468+00:00",
"tcsVersion": "sample string 5",
"privacyStatementVersion": "sample string 6",
"consentValidFrom": "2026-01-29T02:51:56.1248468+00:00",
"consentValidTo": "2026-01-29T02:51:56.1248468+00:00"
},
{
"consentId": 1,
"mpxn": "sample string 2",
"consentReferenceId": "sample string 3",
"evidencePath": "sample string 4",
"statusId": 64,
"consentTypeId": 64,
"withdrawRequestTimestamp": "2026-01-29T02:51:56.1248468+00:00",
"withdrawExecutionTimestamp": "2026-01-29T02:51:56.1248468+00:00",
"tcsVersion": "sample string 5",
"privacyStatementVersion": "sample string 6",
"consentValidFrom": "2026-01-29T02:51:56.1248468+00:00",
"consentValidTo": "2026-01-29T02:51:56.1248468+00:00"
}
],
"moveInDate": "2026-01-29T02:51:56.1248468+00:00"
},
{
"consentUserId": 1,
"consentUserGuid": "e597f81b-ce73-44c1-a8c9-6f680b0b795a",
"referralBranchCode": "sample string 3",
"name": "sample string 4",
"address": {
"city": "sample string 1",
"country": "sample string 2",
"line1": "sample string 3",
"line2": "sample string 4",
"postcode": "sample string 5",
"county": "sample string 6"
},
"email": "sample string 5",
"consents": [
{
"consentId": 1,
"mpxn": "sample string 2",
"consentReferenceId": "sample string 3",
"evidencePath": "sample string 4",
"statusId": 64,
"consentTypeId": 64,
"withdrawRequestTimestamp": "2026-01-29T02:51:56.1248468+00:00",
"withdrawExecutionTimestamp": "2026-01-29T02:51:56.1248468+00:00",
"tcsVersion": "sample string 5",
"privacyStatementVersion": "sample string 6",
"consentValidFrom": "2026-01-29T02:51:56.1248468+00:00",
"consentValidTo": "2026-01-29T02:51:56.1248468+00:00"
},
{
"consentId": 1,
"mpxn": "sample string 2",
"consentReferenceId": "sample string 3",
"evidencePath": "sample string 4",
"statusId": 64,
"consentTypeId": 64,
"withdrawRequestTimestamp": "2026-01-29T02:51:56.1248468+00:00",
"withdrawExecutionTimestamp": "2026-01-29T02:51:56.1248468+00:00",
"tcsVersion": "sample string 5",
"privacyStatementVersion": "sample string 6",
"consentValidFrom": "2026-01-29T02:51:56.1248468+00:00",
"consentValidTo": "2026-01-29T02:51:56.1248468+00:00"
}
],
"moveInDate": "2026-01-29T02:51:56.1248468+00:00"
}
]
application/xml, text/xml
Sample:
<ArrayOfUserConsentsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.N3rgy">
<UserConsentsList>
<Address>
<City>sample string 1</City>
<Country>sample string 2</Country>
<County>sample string 6</County>
<Line1>sample string 3</Line1>
<Line2>sample string 4</Line2>
<Postcode>sample string 5</Postcode>
</Address>
<ConsentUserGuid>e597f81b-ce73-44c1-a8c9-6f680b0b795a</ConsentUserGuid>
<ConsentUserId>1</ConsentUserId>
<Consents>
<Consent>
<ConsentId>1</ConsentId>
<ConsentReferenceId>sample string 3</ConsentReferenceId>
<ConsentTypeId>64</ConsentTypeId>
<ConsentValidFrom>2026-01-29T02:51:56.1248468+00:00</ConsentValidFrom>
<ConsentValidTo>2026-01-29T02:51:56.1248468+00:00</ConsentValidTo>
<EvidencePath>sample string 4</EvidencePath>
<Mpxn>sample string 2</Mpxn>
<PrivacyStatementVersion>sample string 6</PrivacyStatementVersion>
<StatusId>64</StatusId>
<TcsVersion>sample string 5</TcsVersion>
<WithdrawExecutionTimestamp>2026-01-29T02:51:56.1248468+00:00</WithdrawExecutionTimestamp>
<WithdrawRequestTimestamp>2026-01-29T02:51:56.1248468+00:00</WithdrawRequestTimestamp>
</Consent>
<Consent>
<ConsentId>1</ConsentId>
<ConsentReferenceId>sample string 3</ConsentReferenceId>
<ConsentTypeId>64</ConsentTypeId>
<ConsentValidFrom>2026-01-29T02:51:56.1248468+00:00</ConsentValidFrom>
<ConsentValidTo>2026-01-29T02:51:56.1248468+00:00</ConsentValidTo>
<EvidencePath>sample string 4</EvidencePath>
<Mpxn>sample string 2</Mpxn>
<PrivacyStatementVersion>sample string 6</PrivacyStatementVersion>
<StatusId>64</StatusId>
<TcsVersion>sample string 5</TcsVersion>
<WithdrawExecutionTimestamp>2026-01-29T02:51:56.1248468+00:00</WithdrawExecutionTimestamp>
<WithdrawRequestTimestamp>2026-01-29T02:51:56.1248468+00:00</WithdrawRequestTimestamp>
</Consent>
</Consents>
<Email>sample string 5</Email>
<MoveInDate>2026-01-29T02:51:56.1248468+00:00</MoveInDate>
<Name>sample string 4</Name>
<ReferralBranchCode>sample string 3</ReferralBranchCode>
</UserConsentsList>
<UserConsentsList>
<Address>
<City>sample string 1</City>
<Country>sample string 2</Country>
<County>sample string 6</County>
<Line1>sample string 3</Line1>
<Line2>sample string 4</Line2>
<Postcode>sample string 5</Postcode>
</Address>
<ConsentUserGuid>e597f81b-ce73-44c1-a8c9-6f680b0b795a</ConsentUserGuid>
<ConsentUserId>1</ConsentUserId>
<Consents>
<Consent>
<ConsentId>1</ConsentId>
<ConsentReferenceId>sample string 3</ConsentReferenceId>
<ConsentTypeId>64</ConsentTypeId>
<ConsentValidFrom>2026-01-29T02:51:56.1248468+00:00</ConsentValidFrom>
<ConsentValidTo>2026-01-29T02:51:56.1248468+00:00</ConsentValidTo>
<EvidencePath>sample string 4</EvidencePath>
<Mpxn>sample string 2</Mpxn>
<PrivacyStatementVersion>sample string 6</PrivacyStatementVersion>
<StatusId>64</StatusId>
<TcsVersion>sample string 5</TcsVersion>
<WithdrawExecutionTimestamp>2026-01-29T02:51:56.1248468+00:00</WithdrawExecutionTimestamp>
<WithdrawRequestTimestamp>2026-01-29T02:51:56.1248468+00:00</WithdrawRequestTimestamp>
</Consent>
<Consent>
<ConsentId>1</ConsentId>
<ConsentReferenceId>sample string 3</ConsentReferenceId>
<ConsentTypeId>64</ConsentTypeId>
<ConsentValidFrom>2026-01-29T02:51:56.1248468+00:00</ConsentValidFrom>
<ConsentValidTo>2026-01-29T02:51:56.1248468+00:00</ConsentValidTo>
<EvidencePath>sample string 4</EvidencePath>
<Mpxn>sample string 2</Mpxn>
<PrivacyStatementVersion>sample string 6</PrivacyStatementVersion>
<StatusId>64</StatusId>
<TcsVersion>sample string 5</TcsVersion>
<WithdrawExecutionTimestamp>2026-01-29T02:51:56.1248468+00:00</WithdrawExecutionTimestamp>
<WithdrawRequestTimestamp>2026-01-29T02:51:56.1248468+00:00</WithdrawRequestTimestamp>
</Consent>
</Consents>
<Email>sample string 5</Email>
<MoveInDate>2026-01-29T02:51:56.1248468+00:00</MoveInDate>
<Name>sample string 4</Name>
<ReferralBranchCode>sample string 3</ReferralBranchCode>
</UserConsentsList>
</ArrayOfUserConsentsList>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].ConsentUserId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].ConsentUserGuid" e597f81b-ce73-44c1-a8c9-6f680b0b795a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].ReferralBranchCode" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Name" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Address.City" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Address.Country" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Address.Line1" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Address.Line2" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Address.Postcode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Address.County" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Email" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].ConsentId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].Mpxn" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].ConsentReferenceId" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].EvidencePath" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].StatusId" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].ConsentTypeId" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].WithdrawRequestTimestamp" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].WithdrawExecutionTimestamp" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].TcsVersion" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].PrivacyStatementVersion" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].ConsentValidFrom" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[0].ConsentValidTo" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].ConsentId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].Mpxn" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].ConsentReferenceId" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].EvidencePath" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].StatusId" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].ConsentTypeId" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].WithdrawRequestTimestamp" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].WithdrawExecutionTimestamp" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].TcsVersion" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].PrivacyStatementVersion" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].ConsentValidFrom" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Consents[1].ConsentValidTo" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].MoveInDate" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].ConsentUserId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].ConsentUserGuid" e597f81b-ce73-44c1-a8c9-6f680b0b795a --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].ReferralBranchCode" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Name" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Address.City" sample string 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Address.Country" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Address.Line1" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Address.Line2" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Address.Postcode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Address.County" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Email" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].ConsentId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].Mpxn" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].ConsentReferenceId" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].EvidencePath" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].StatusId" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].ConsentTypeId" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].WithdrawRequestTimestamp" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].WithdrawExecutionTimestamp" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].TcsVersion" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].PrivacyStatementVersion" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].ConsentValidFrom" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[0].ConsentValidTo" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].ConsentId" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].Mpxn" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].ConsentReferenceId" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].EvidencePath" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].StatusId" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].ConsentTypeId" 64 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].WithdrawRequestTimestamp" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].WithdrawExecutionTimestamp" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].TcsVersion" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].PrivacyStatementVersion" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].ConsentValidFrom" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Consents[1].ConsentValidTo" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].MoveInDate" 2026-01-29T02:51:56.1248468+00:00 --MultipartDataMediaFormatterBoundary1q2w3e--