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

Property. Processes this list API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageSize	The page size value supplied with the request.	integer	Default value is 20
pageNumber	The page number value supplied with the request.	integer	Default value is 1

Body Parameters

The property list filter data contract supplied with the request.

PropertyListFilterDataContract

Name	Description	Type	Additional information
Ids	The unique identifiers of the related api resources.	Collection of integer	None.
NegotiatorIds	The unique identifiers of the related negotiator resources.	Collection of integer	None.
OwningTeamIds	The unique identifiers of the related owning team resources.	Collection of integer	None.
ExchangedRecordedBy	The collection of exchanged recorded by.	Collection of integer	None.
ExchangeFrom	The exchange from, expressed as a date and time.	date	None.
ExchangeTo	The exchange to, expressed as a date and time.	date	None.
Exchange	The exchange value.	DateRangeFilterDataContract	None.
CompletionsFrom	The completions from, expressed as a date and time.	date	None.
CompletionsTo	The completions to, expressed as a date and time.	date	None.
Completions	The completions value.	DateRangeFilterDataContract	None.
OfferAcceptedFrom	The offer accepted from, expressed as a date and time.	date	None.
OfferAcceptedTo	The offer accepted to, expressed as a date and time.	date	None.
OfferAccepted	The offer accepted value.	DateRangeFilterDataContract	None.
InstructedFrom	The instructed from, expressed as a date and time.	date	None.
InstructedTo	The instructed to, expressed as a date and time.	date	None.
Instructed	The instructed value.	DateRangeFilterDataContract	None.
WithdrawnInstructionFrom	The withdrawn instruction from, expressed as a date and time.	date	None.
WithdrawnInstructionTo	The withdrawn instruction to, expressed as a date and time.	date	None.
WithdrawnInstruction	The withdrawn instruction value.	DateRangeFilterDataContract	None.
ValuedFrom	The valued from, expressed as a date and time.	date	None.
ValuedTo	The valued to, expressed as a date and time.	date	None.
Valued	The valued value.	DateRangeFilterDataContract	None.
WithdrawnValuationFrom	The withdrawn valuation from, expressed as a date and time.	date	None.
WithdrawnValuationTo	The withdrawn valuation to, expressed as a date and time.	date	None.
WithdrawnValuation	The withdrawn valuation value.	DateRangeFilterDataContract	None.
CreatedFrom	The created from, expressed as a date and time.	date	None.
CreatedTo	The created to, expressed as a date and time.	date	None.
Created	The created value.	DateRangeFilterDataContract	None.
UpdatedFrom	The updated from, expressed as a date and time.	date	None.
UpdatedTo	The updated to, expressed as a date and time.	date	None.
Updated	The updated value.	DateRangeFilterDataContract	None.
ContractEndDateFrom	The contract end date from, expressed as a date and time.	date	None.
ContractEndDateTo	The contract end date to, expressed as a date and time.	date	None.
ContractEndDate	The contract end date value.	DateRangeFilterDataContract	None.
LetFrom	The let from, expressed as a date and time.	date	None.
LetTo	The let to, expressed as a date and time.	date	None.
Let	The let value.	DateRangeFilterDataContract	None.
BedroomsMin	The bedrooms min value.	integer	None.
BedroomsMax	The bedrooms max value.	integer	None.
HasGarage	Indicates whether this item has garage.	boolean	None.
HasGarden	Indicates whether this item has garden.	boolean	None.
PriceRangeMin	The price range min value.	integer	None.
PriceRangeMax	The price range max value.	integer	None.
PriceType	The price type value.	string	None.
TagIds	The unique identifiers of the related tag resources.	Collection of integer	None.
RoleTypes	The collection of role types.	Collection of string	None.
RoleStatuses	The collection of role statuses.	Collection of string	None.
PropertyTypes	The collection of property types.	Collection of string	None.
MarketingFlags	The collection of marketing flags.	Dictionary of string [key] and boolean [value]	None.
Latitude	The latitude value.	decimal number	None.
Longitude	The longitude value.	decimal number	None.
MileRadius	The mile radius value.	decimal number	None.
Sort	The sort classification.	PropertyListSort	None.
RegionIds	The unique identifiers of the related region resources.	Collection of integer	None.
RegionId	The unique identifier of the related region resource.	integer	None.
RegionSource	The region source value.	string	None.
RegionType	The region type value.	string	None.
ReferralType	The referral type value.	string	None.
AdditionalIds	The unique identifiers of the related additional resources.	Collection of integer	None.
ExcludedIds	The unique identifiers of the related excluded resources.	Collection of integer	None.
PropertyIds	The unique identifiers of the related property resources.	Collection of integer	None.
PropertyAddressIds	The unique identifiers of the related property address resources.	Collection of string	None.
IsThereEpcValuesRecorded	Indicates whether this item is there epc values recorded.	boolean	None.
SearchOwnersWithTerm	Indicates whether search owners with term is true.	boolean	None.
EpcExpiryDate	The epc expiry date value.	DateRangeFilterDataContract	None.
PropertyMarketingDate	The property marketing date value.	DateRangeFilterDataContract	None.
IsEmbeddedSearchList	Indicates whether this item is embedded search list.	boolean	None.
PreviousPage	The previous page value.	integer	None.
PreviousElasticSearchIndex	The previous elastic search index value.	integer	None.
ClosingDate	The closing date value.	DateRangeFilterDataContract	None.
Name	The name value.	string	None.
CustomFilterConfig	The custom filter config value.	string	None.
BranchId	The unique identifier of the related branch resource.	integer	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
EventBranchIds	The unique identifiers of the related event branch resources.	Collection of integer	None.
Order	The order classification.	ListOrder	None.
SearchTerm	The search term value.	string	None.
FilterType	The filter type value.	EnumDataContract	None.
ShowDeleted	Indicates whether show deleted is true.	boolean	None.
ShowCancelled	Indicates whether show cancelled is true.	boolean	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
Id	The unique identifier of this resource.	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": "2026-08-04T22:23:41.8253347Z",
  "ExchangeTo": "2026-08-04T22:23:41.8253347Z",
  "Exchange": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CompletionsFrom": "2026-08-04T22:23:41.8253347Z",
  "CompletionsTo": "2026-08-04T22:23:41.8253347Z",
  "Completions": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "OfferAcceptedFrom": "2026-08-04T22:23:41.8253347Z",
  "OfferAcceptedTo": "2026-08-04T22:23:41.8253347Z",
  "OfferAccepted": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "InstructedFrom": "2026-08-04T22:23:41.8253347Z",
  "InstructedTo": "2026-08-04T22:23:41.8253347Z",
  "Instructed": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "WithdrawnInstructionFrom": "2026-08-04T22:23:41.8253347Z",
  "WithdrawnInstructionTo": "2026-08-04T22:23:41.8253347Z",
  "WithdrawnInstruction": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "ValuedFrom": "2026-08-04T22:23:41.8253347Z",
  "ValuedTo": "2026-08-04T22:23:41.8253347Z",
  "Valued": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "WithdrawnValuationFrom": "2026-08-04T22:23:41.8253347Z",
  "WithdrawnValuationTo": "2026-08-04T22:23:41.8253347Z",
  "WithdrawnValuation": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "CreatedFrom": "2026-08-04T22:23:41.8253347Z",
  "CreatedTo": "2026-08-04T22:23:41.8253347Z",
  "Created": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "UpdatedFrom": "2026-08-04T22:23:41.8253347Z",
  "UpdatedTo": "2026-08-04T22:23:41.8253347Z",
  "Updated": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "ContractEndDateFrom": "2026-08-04T22:23:41.8253347Z",
  "ContractEndDateTo": "2026-08-04T22:23:41.8253347Z",
  "ContractEndDate": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "LetFrom": "2026-08-04T22:23:41.8253347Z",
  "LetTo": "2026-08-04T22:23:41.8253347Z",
  "Let": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "BedroomsMin": 1,
  "BedroomsMax": 1,
  "HasGarage": true,
  "HasGarden": true,
  "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": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "PropertyMarketingDate": {
    "FromStaticDate": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "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": "2026-08-04T22:23:41.8253347Z",
    "ToStaticDate": "2026-08-04T22:23:41.8253347Z",
    "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

The response returned after the operation completes.

PagedCollectionDataContractOfPropertyListDataContract

Name	Description	Type	Additional information
TotalCount	The total count value.	integer	None.
CurrentCount	The current count value.	integer	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Collection	The collection of collection.	Collection of PropertyListDataContract	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.