POST api/list/property?pageSize={pageSize}&pageNumber={pageNumber}

Request Information

URI Parameters

Name	Description	Type	Additional information
pageSize		integer	Default value is 20
pageNumber		integer	Default value is 1

Body Parameters

PropertyListFilterDataContract

Name	Type	Additional information
Ids	Collection of integer	None.
NegotiatorIds	Collection of integer	None.
OwningTeamIds	Collection of integer	None.
ExchangedRecordedBy	Collection of integer	None.
ExchangeFrom	date	None.
ExchangeTo	date	None.
Exchange	DateRangeFilterDataContract	None.
CompletionsFrom	date	None.
CompletionsTo	date	None.
Completions	DateRangeFilterDataContract	None.
OfferAcceptedFrom	date	None.
OfferAcceptedTo	date	None.
OfferAccepted	DateRangeFilterDataContract	None.
InstructedFrom	date	None.
InstructedTo	date	None.
Instructed	DateRangeFilterDataContract	None.
WithdrawnInstructionFrom	date	None.
WithdrawnInstructionTo	date	None.
WithdrawnInstruction	DateRangeFilterDataContract	None.
ValuedFrom	date	None.
ValuedTo	date	None.
Valued	DateRangeFilterDataContract	None.
WithdrawnValuationFrom	date	None.
WithdrawnValuationTo	date	None.
WithdrawnValuation	DateRangeFilterDataContract	None.
CreatedFrom	date	None.
CreatedTo	date	None.
Created	DateRangeFilterDataContract	None.
UpdatedFrom	date	None.
UpdatedTo	date	None.
Updated	DateRangeFilterDataContract	None.
ContractEndDateFrom	date	None.
ContractEndDateTo	date	None.
ContractEndDate	DateRangeFilterDataContract	None.
LetFrom	date	None.
LetTo	date	None.
Let	DateRangeFilterDataContract	None.
BedroomsMin	integer	None.
PriceRangeMin	integer	None.
PriceRangeMax	integer	None.
PriceType	string	None.
TagIds	Collection of integer	None.
RoleTypes	Collection of string	None.
RoleStatuses	Collection of string	None.
PropertyTypes	Collection of string	None.
MarketingFlags	Dictionary of string [key] and boolean [value]	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
MileRadius	decimal number	None.
Sort	PropertyListSort	None.
RegionIds	Collection of integer	None.
RegionId	integer	None.
RegionSource	string	None.
RegionType	string	None.
ReferralType	string	None.
AdditionalIds	Collection of integer	None.
ExcludedIds	Collection of integer	None.
PropertyIds	Collection of integer	None.
PropertyAddressIds	Collection of string	None.
IsThereEpcValuesRecorded	boolean	None.
SearchOwnersWithTerm	boolean	None.
EpcExpiryDate	DateRangeFilterDataContract	None.
PropertyMarketingDate	DateRangeFilterDataContract	None.
IsEmbeddedSearchList	boolean	None.
PreviousPage	integer	None.
PreviousElasticSearchIndex	integer	None.
ClosingDate	DateRangeFilterDataContract	None.
Name	string	None.
CustomFilterConfig	string	None.
BranchId	integer	None.
BranchIds	Collection of integer	None.
EventBranchIds	Collection of integer	None.
Order	ListOrder	None.
SearchTerm	string	None.
FilterType	EnumDataContract	None.
ShowDeleted	boolean	None.
ShowCancelled	boolean	None.
OwningTeamId	integer	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Ids": [
    1,
    2
  ],
  "NegotiatorIds": [
    1,
    2
  ],
  "OwningTeamIds": [
    1,
    2
  ],
  "ExchangedRecordedBy": [
    1,
    2
  ],
  "ExchangeFrom": "2025-11-12T18:34:37.4159008Z",
  "ExchangeTo": "2025-11-12T18:34:37.4159008Z",
  "Exchange": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CompletionsFrom": "2025-11-12T18:34:37.4159008Z",
  "CompletionsTo": "2025-11-12T18:34:37.4159008Z",
  "Completions": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "OfferAcceptedFrom": "2025-11-12T18:34:37.4159008Z",
  "OfferAcceptedTo": "2025-11-12T18:34:37.4159008Z",
  "OfferAccepted": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "InstructedFrom": "2025-11-12T18:34:37.4159008Z",
  "InstructedTo": "2025-11-12T18:34:37.4159008Z",
  "Instructed": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "WithdrawnInstructionFrom": "2025-11-12T18:34:37.4159008Z",
  "WithdrawnInstructionTo": "2025-11-12T18:34:37.4315297Z",
  "WithdrawnInstruction": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "ValuedFrom": "2025-11-12T18:34:37.4315297Z",
  "ValuedTo": "2025-11-12T18:34:37.4315297Z",
  "Valued": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "WithdrawnValuationFrom": "2025-11-12T18:34:37.4315297Z",
  "WithdrawnValuationTo": "2025-11-12T18:34:37.4315297Z",
  "WithdrawnValuation": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CreatedFrom": "2025-11-12T18:34:37.4315297Z",
  "CreatedTo": "2025-11-12T18:34:37.4315297Z",
  "Created": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "UpdatedFrom": "2025-11-12T18:34:37.4315297Z",
  "UpdatedTo": "2025-11-12T18:34:37.4315297Z",
  "Updated": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "ContractEndDateFrom": "2025-11-12T18:34:37.4315297Z",
  "ContractEndDateTo": "2025-11-12T18:34:37.4315297Z",
  "ContractEndDate": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "LetFrom": "2025-11-12T18:34:37.4315297Z",
  "LetTo": "2025-11-12T18:34:37.4315297Z",
  "Let": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "BedroomsMin": 1,
  "PriceRangeMin": 1,
  "PriceRangeMax": 1,
  "PriceType": "sample string 2",
  "TagIds": [
    1,
    2
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "PropertyTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "MarketingFlags": {
    "sample string 1": true,
    "sample string 3": true
  },
  "Latitude": 1.1,
  "Longitude": 1.1,
  "MileRadius": 1.1,
  "Sort": 0,
  "RegionIds": [
    1,
    2
  ],
  "RegionId": 1,
  "RegionSource": "sample string 3",
  "RegionType": "sample string 4",
  "ReferralType": "sample string 5",
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "PropertyIds": [
    1,
    2
  ],
  "PropertyAddressIds": [
    "sample string 1",
    "sample string 2"
  ],
  "IsThereEpcValuesRecorded": true,
  "SearchOwnersWithTerm": true,
  "EpcExpiryDate": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "PropertyMarketingDate": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "IsEmbeddedSearchList": true,
  "PreviousPage": 7,
  "PreviousElasticSearchIndex": 8,
  "ClosingDate": {
    "FromStaticDate": "2025-11-12T18:34:37.4159008Z",
    "ToStaticDate": "2025-11-12T18:34:37.4159008Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "Name": "sample string 9",
  "CustomFilterConfig": "sample string 10",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 11",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 14,
  "Id": 15
}

Response Information

Resource Description

PagedCollectionDataContractOfPropertyListDataContract

Name	Type	Additional information
TotalCount	integer	None.
CurrentCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
Collection	Collection of PropertyListDataContract	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.