Retrieve listings from Propertybase with filtering, sorting, and pagination. Returns XML or JSON.
Query parameters
-
Your webserviceWebListings_token
-
Semicolon-separated field API names (e.g., name;pba_ListingPrice_pbc;pbaBedrooms_pb_c)
-
Number of results per page (default: 20, max: 1000)
Default value is
20. -
Page number (0-indexed)
Default value is
0. -
Sort field and direction (e.g., pba_ListingPrice_pb_c;ASC)
-
Include image URLs
Default value is
false. -
Include video URLs
Default value is
false. -
Include document URLs
Default value is
false. -
Include debug messages in response
Default value is
false.
GET
/pba__WebserviceListingsQuery
curl \
--request GET 'https://yoursitename.secure.force.com/pba__WebserviceListingsQuery?token=string&fields=string' \
--header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"page": 42,
"listingsPerPage": 42,
"numberOfListings": 42,
"fatalError": true,
"errorMessages": [
"string"
],
"debugMessages": [
"string"
],
"listings": [
{
"data": {
"id": "string",
"name": "string",
"pba__ListingPrice_pb__c": 42.0,
"pba__Bedrooms_pb__c": 42.0,
"pba__FullBathrooms_pb__c": 42.0
},
"media": {
"images": [
{
"title": "string",
"filename": "string",
"tags": "string",
"mimetype": "string",
"url": "https://example.com",
"baseurl": "https://example.com",
"external": true
}
],
"videos": [
{
"title": "string",
"filename": "string",
"tags": "string",
"mimetype": "string",
"url": "https://example.com",
"baseurl": "https://example.com",
"external": true
}
],
"documents": [
{
"title": "string",
"filename": "string",
"tags": "string",
"mimetype": "string",
"url": "https://example.com",
"baseurl": "https://example.com",
"external": true
}
]
}
}
]
}