GET api/reviews?pageNumber={pageNumber}&pageSize={pageSize}
Get all reviews for the authorized user with pagination.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| pageNumber |
Page number |
integer |
Required |
| pageSize |
Page size (should be less or equal to 100) |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ReviewsResponseViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ReviewCount |
Gets or sets review count. |
integer |
None. |
| CurrentPage |
Gets or sets current page. |
integer |
None. |
| TotalPages |
Gets or sets total pages. |
integer |
None. |
| Reviews |
ReviewsResponse |
Collection of ReviewViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"ReviewCount": 1,
"CurrentPage": 1,
"TotalPages": 1,
"Reviews": [
{
"ReviewId": 1,
"UserKey": "sample string 1",
"Title": "sample string 2",
"Text": "sample string 3",
"Rating": 1,
"CreatedDate": "2025-04-02T17:37:47.9916706-04:00",
"Comments": [
{
"CommentId": 1,
"CommentText": "sample string 1",
"CreatedDate": "2025-04-02T17:37:47.9916706-04:00",
"CultureCode": "sample string 2",
"CommentTranslations": [
{
"CultureCode": "sample string 1",
"CommentText": "sample string 2"
},
{
"CultureCode": "sample string 1",
"CommentText": "sample string 2"
}
]
},
{
"CommentId": 1,
"CommentText": "sample string 1",
"CreatedDate": "2025-04-02T17:37:47.9916706-04:00",
"CultureCode": "sample string 2",
"CommentTranslations": [
{
"CultureCode": "sample string 1",
"CommentText": "sample string 2"
},
{
"CultureCode": "sample string 1",
"CommentText": "sample string 2"
}
]
}
],
"ReviewAddress": {
"ReviewAddressId": 1,
"ListingKey": "sample string 1",
"StreetAddress": "sample string 2",
"City": "sample string 3",
"StateCode": "sample string 4",
"CountryCode": "sample string 5",
"Zip": "sample string 6",
"PropertyName": "sample string 7",
"ProfileUrl": "sample string 8",
"Rating": 64
},
"CultureCode": "sample string 4",
"ReviewTranslations": [
{
"CultureCode": "sample string 1",
"Title": "sample string 2",
"Text": "sample string 3"
},
{
"CultureCode": "sample string 1",
"Title": "sample string 2",
"Text": "sample string 3"
}
]
},
{
"ReviewId": 1,
"UserKey": "sample string 1",
"Title": "sample string 2",
"Text": "sample string 3",
"Rating": 1,
"CreatedDate": "2025-04-02T17:37:47.9916706-04:00",
"Comments": [
{
"CommentId": 1,
"CommentText": "sample string 1",
"CreatedDate": "2025-04-02T17:37:47.9916706-04:00",
"CultureCode": "sample string 2",
"CommentTranslations": [
{
"CultureCode": "sample string 1",
"CommentText": "sample string 2"
},
{
"CultureCode": "sample string 1",
"CommentText": "sample string 2"
}
]
},
{
"CommentId": 1,
"CommentText": "sample string 1",
"CreatedDate": "2025-04-02T17:37:47.9916706-04:00",
"CultureCode": "sample string 2",
"CommentTranslations": [
{
"CultureCode": "sample string 1",
"CommentText": "sample string 2"
},
{
"CultureCode": "sample string 1",
"CommentText": "sample string 2"
}
]
}
],
"ReviewAddress": {
"ReviewAddressId": 1,
"ListingKey": "sample string 1",
"StreetAddress": "sample string 2",
"City": "sample string 3",
"StateCode": "sample string 4",
"CountryCode": "sample string 5",
"Zip": "sample string 6",
"PropertyName": "sample string 7",
"ProfileUrl": "sample string 8",
"Rating": 64
},
"CultureCode": "sample string 4",
"ReviewTranslations": [
{
"CultureCode": "sample string 1",
"Title": "sample string 2",
"Text": "sample string 3"
},
{
"CultureCode": "sample string 1",
"Title": "sample string 2",
"Text": "sample string 3"
}
]
}
]
}
application/xml, text/xml
Sample:
<ReviewsResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Models.Review">
<CurrentPage>1</CurrentPage>
<ReviewCount>1</ReviewCount>
<Reviews>
<ReviewViewModel>
<Comments xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Models.Comment">
<d4p1:CommentViewModel>
<d4p1:CommentId>1</d4p1:CommentId>
<d4p1:CommentText>sample string 1</d4p1:CommentText>
<d4p1:CommentTranslations>
<d4p1:CommentTranslationViewModel>
<d4p1:CommentText>sample string 2</d4p1:CommentText>
<d4p1:CultureCode>sample string 1</d4p1:CultureCode>
</d4p1:CommentTranslationViewModel>
<d4p1:CommentTranslationViewModel>
<d4p1:CommentText>sample string 2</d4p1:CommentText>
<d4p1:CultureCode>sample string 1</d4p1:CultureCode>
</d4p1:CommentTranslationViewModel>
</d4p1:CommentTranslations>
<d4p1:CreatedDate>2025-04-02T17:37:47.9916706-04:00</d4p1:CreatedDate>
<d4p1:CultureCode>sample string 2</d4p1:CultureCode>
</d4p1:CommentViewModel>
<d4p1:CommentViewModel>
<d4p1:CommentId>1</d4p1:CommentId>
<d4p1:CommentText>sample string 1</d4p1:CommentText>
<d4p1:CommentTranslations>
<d4p1:CommentTranslationViewModel>
<d4p1:CommentText>sample string 2</d4p1:CommentText>
<d4p1:CultureCode>sample string 1</d4p1:CultureCode>
</d4p1:CommentTranslationViewModel>
<d4p1:CommentTranslationViewModel>
<d4p1:CommentText>sample string 2</d4p1:CommentText>
<d4p1:CultureCode>sample string 1</d4p1:CultureCode>
</d4p1:CommentTranslationViewModel>
</d4p1:CommentTranslations>
<d4p1:CreatedDate>2025-04-02T17:37:47.9916706-04:00</d4p1:CreatedDate>
<d4p1:CultureCode>sample string 2</d4p1:CultureCode>
</d4p1:CommentViewModel>
</Comments>
<CreatedDate>2025-04-02T17:37:47.9916706-04:00</CreatedDate>
<CultureCode>sample string 4</CultureCode>
<Rating>1</Rating>
<ReviewAddress>
<City>sample string 3</City>
<CountryCode>sample string 5</CountryCode>
<ListingKey>sample string 1</ListingKey>
<ProfileUrl>sample string 8</ProfileUrl>
<PropertyName>sample string 7</PropertyName>
<Rating>64</Rating>
<ReviewAddressId>1</ReviewAddressId>
<StateCode>sample string 4</StateCode>
<StreetAddress>sample string 2</StreetAddress>
<Zip>sample string 6</Zip>
</ReviewAddress>
<ReviewId>1</ReviewId>
<ReviewTranslations>
<ReviewTranslationViewModel>
<CultureCode>sample string 1</CultureCode>
<Text>sample string 3</Text>
<Title>sample string 2</Title>
</ReviewTranslationViewModel>
<ReviewTranslationViewModel>
<CultureCode>sample string 1</CultureCode>
<Text>sample string 3</Text>
<Title>sample string 2</Title>
</ReviewTranslationViewModel>
</ReviewTranslations>
<Text>sample string 3</Text>
<Title>sample string 2</Title>
<UserKey>sample string 1</UserKey>
</ReviewViewModel>
<ReviewViewModel>
<Comments xmlns:d4p1="http://schemas.datacontract.org/2004/07/Apts.Api.WebApi.Models.Comment">
<d4p1:CommentViewModel>
<d4p1:CommentId>1</d4p1:CommentId>
<d4p1:CommentText>sample string 1</d4p1:CommentText>
<d4p1:CommentTranslations>
<d4p1:CommentTranslationViewModel>
<d4p1:CommentText>sample string 2</d4p1:CommentText>
<d4p1:CultureCode>sample string 1</d4p1:CultureCode>
</d4p1:CommentTranslationViewModel>
<d4p1:CommentTranslationViewModel>
<d4p1:CommentText>sample string 2</d4p1:CommentText>
<d4p1:CultureCode>sample string 1</d4p1:CultureCode>
</d4p1:CommentTranslationViewModel>
</d4p1:CommentTranslations>
<d4p1:CreatedDate>2025-04-02T17:37:47.9916706-04:00</d4p1:CreatedDate>
<d4p1:CultureCode>sample string 2</d4p1:CultureCode>
</d4p1:CommentViewModel>
<d4p1:CommentViewModel>
<d4p1:CommentId>1</d4p1:CommentId>
<d4p1:CommentText>sample string 1</d4p1:CommentText>
<d4p1:CommentTranslations>
<d4p1:CommentTranslationViewModel>
<d4p1:CommentText>sample string 2</d4p1:CommentText>
<d4p1:CultureCode>sample string 1</d4p1:CultureCode>
</d4p1:CommentTranslationViewModel>
<d4p1:CommentTranslationViewModel>
<d4p1:CommentText>sample string 2</d4p1:CommentText>
<d4p1:CultureCode>sample string 1</d4p1:CultureCode>
</d4p1:CommentTranslationViewModel>
</d4p1:CommentTranslations>
<d4p1:CreatedDate>2025-04-02T17:37:47.9916706-04:00</d4p1:CreatedDate>
<d4p1:CultureCode>sample string 2</d4p1:CultureCode>
</d4p1:CommentViewModel>
</Comments>
<CreatedDate>2025-04-02T17:37:47.9916706-04:00</CreatedDate>
<CultureCode>sample string 4</CultureCode>
<Rating>1</Rating>
<ReviewAddress>
<City>sample string 3</City>
<CountryCode>sample string 5</CountryCode>
<ListingKey>sample string 1</ListingKey>
<ProfileUrl>sample string 8</ProfileUrl>
<PropertyName>sample string 7</PropertyName>
<Rating>64</Rating>
<ReviewAddressId>1</ReviewAddressId>
<StateCode>sample string 4</StateCode>
<StreetAddress>sample string 2</StreetAddress>
<Zip>sample string 6</Zip>
</ReviewAddress>
<ReviewId>1</ReviewId>
<ReviewTranslations>
<ReviewTranslationViewModel>
<CultureCode>sample string 1</CultureCode>
<Text>sample string 3</Text>
<Title>sample string 2</Title>
</ReviewTranslationViewModel>
<ReviewTranslationViewModel>
<CultureCode>sample string 1</CultureCode>
<Text>sample string 3</Text>
<Title>sample string 2</Title>
</ReviewTranslationViewModel>
</ReviewTranslations>
<Text>sample string 3</Text>
<Title>sample string 2</Title>
<UserKey>sample string 1</UserKey>
</ReviewViewModel>
</Reviews>
<TotalPages>1</TotalPages>
</ReviewsResponseViewModel>